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 · Exemplos · Endpoints

Índice clicável

Usuários — Usuario · Lojas e filiais — Loja · Campos personalizados — CampoPersonalizado · Documentos emitidos — Documento · Arquivos e anexos — Arquivo · Etiquetas — Etiqueta · Pendências — Pendencia · Ordens de serviço — OrdemServico · Instalação e obras — Instalacao · Equipes técnicas — EquipeTecnica · Tipos de serviço — TipoServico · Status de ordem de serviço — StatusOrdemServico · Rotas de entrega — RotaEntrega · Veículos — Veiculo · Automações de ordem de serviço — AutomacoesStatusOrdemServico · Automações de instalação — 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):

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

Resposta ilustrativa — HTTP 200:

{
  "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; query pagingParams: PagingParams.

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

Voltar ao índice

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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; query pagingParams: PagingParams.

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

Voltar ao índice

GET /api/Loja/{id}

path id: long.

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

Voltar ao índice

POST /api/Loja

body model: LojaInputDTO — LojaInputDTO.

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

Voltar ao índice

PUT /api/Loja/{id}

path id: long; body model: EditarPropriedadeInputDTO — EditarPropriedadeInputDTO.

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

Voltar ao índice

PUT /api/Loja/EditarImagem/{id}

path id: long; query arquivoId: long.

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

Voltar ao índice

DELETE /api/Loja/{id}

path id: long.

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

Voltar ao índice

POST /api/Loja/AdicionarHorario/{id}

path id: long; query model: AddHorarioInputDTO — AddHorarioInputDTO.

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

Voltar ao índice

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

path id: long; path horarioId: long.

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

Voltar ao índice

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

path id: long; path idLojaOrigem: long.

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

Voltar ao índice

POST /api/Loja/Duplicar/{id}

path id: long; body model: DuplicarLojaInputDTO — DuplicarLojaInputDTO.

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

Voltar ao índice

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

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

POST /api/Loja/AdicionarIrradiacao12Meses/{id}

path id: long; query consumo: double.

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

Voltar ao índice

POST /api/Loja/RemoverIrradiacao12Meses/{id}

path id: long; query consumo: double.

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

Voltar ao índice

PUT /api/Loja/EditarEndereco/{id}

path id: long; body model: EnderecoInputDTO — EnderecoInputDTO.

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

Voltar ao índice

Campos personalizados — CampoPersonalizado

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

GET /api/CampoPersonalizado

query filtro: FiltroCampoPersonalizadoInputDTO — FiltroCampoPersonalizadoInputDTO; query pagingParams: PagingParams.

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

Voltar ao índice

GET /api/CampoPersonalizado/TabelaAvancada

query loadOptions: DataSourceLoadOptions.

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

Voltar ao índice

GET /api/CampoPersonalizado/CamposRespostas

query filtro: FiltroRespostaCampoPersonalizadoInputDTO — FiltroRespostaCampoPersonalizadoInputDTO.

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

Voltar ao índice

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

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

GET /api/CampoPersonalizado/{id}

path id: long.

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

Voltar ao índice

POST /api/CampoPersonalizado

body model: CampoPersonalizadoInputDTO — CampoPersonalizadoInputDTO.

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

Voltar ao índice

PUT /api/CampoPersonalizado/{id}

path id: long; body model: EditarPropriedadeInputDTO — EditarPropriedadeInputDTO.

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

Voltar ao índice

PUT /api/CampoPersonalizado/Editar/{id}

path id: long; body model: CampoPersonalizadoInputDTO — CampoPersonalizadoInputDTO.

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

Voltar ao índice

DELETE /api/CampoPersonalizado/{id}

path id: long.

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

Voltar ao índice

POST /api/CampoPersonalizado/{id}/AdicionarOpcao

path id: long; body model: OpcaoCampoInputDTO — OpcaoCampoInputDTO.

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

Voltar ao índice

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

POST /api/CampoPersonalizado/{id}/Responder

path id: long; body model: RespostaCampoPersonalizadoInputDTO — RespostaCampoPersonalizadoInputDTO.

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

Voltar ao índice

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

PUT /api/CampoPersonalizado/Resposta/{respostaId}

path respostaId: long; body model: RespostaEditarCampoPersonalizadoInputDTO — RespostaEditarCampoPersonalizadoInputDTO.

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

Voltar ao índice

POST /api/CampoPersonalizado/AdicionarFuncao/{id}

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

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

Voltar ao índice

POST /api/CampoPersonalizado/RemoverFuncao/{id}

path id: long; query funcaoId: long.

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

Voltar ao índice

POST /api/CampoPersonalizado/AdicionarFuncaoEditar/{id}

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

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

Voltar ao índice

POST /api/CampoPersonalizado/RemoverFuncaoEditar/{id}

path id: long; query funcaoId: long.

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

Voltar ao índice

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

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

GET /api/CampoPersonalizado/CardsIniciais

query etapaId: long; query somenteAtivos: bool?.

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

Voltar ao índice

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

POST /api/CampoPersonalizado/ResponderFormulario

body model: ResponderFormularioCampoPersonalizadoInputDTO — ResponderFormularioCampoPersonalizadoInputDTO.

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

Voltar ao índice

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

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

Documentos emitidos — Documento

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

GET /api/Documento

query filtro: FiltroDocumentoInputDTO — FiltroDocumentoInputDTO; query pagingParams: PagingParams.

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

Voltar ao índice

GET /api/Documento/Geral

query filtro: FiltroDocumentoInputDTO — FiltroDocumentoInputDTO; query pagingParams: PagingParams.

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

Voltar ao índice

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

GET /api/Documento/Summary

query filtro: FiltroDocumentoInputDTO — FiltroDocumentoInputDTO.

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

Voltar ao índice

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

POST /api/Documento

body model: DocumentoInputDTO — DocumentoInputDTO.

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

Voltar ao índice

PUT /api/Documento/{id}

path id: long; body model: EditarPropriedadeInputDTO — EditarPropriedadeInputDTO.

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

Voltar ao índice

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

DELETE /api/Documento/{id}

path id: long.

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

Voltar ao índice

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

GET /api/Documento/VisualizarDemoHtml

query modeloId: long?.

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

Voltar ao índice

GET /api/Documento/GerarPDF/{id}

path id: long.

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

Voltar ao índice

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

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

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

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

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

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

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

POST /api/Documento/WebHookClickSign

body model: EventRequestClickSignOutPutDTO — EventRequestClickSignOutPutDTO.

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

Voltar ao índice

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.

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

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

Voltar ao índice

GET /api/Arquivo

query filtro: FiltroArquivoInputDTO — FiltroArquivoInputDTO; query pagingParams: PagingParams.

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

Voltar ao índice

GET /api/Arquivo/{id}

path id: long.

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

Voltar ao índice

GET /api/Arquivo/DownloadArquivosProjeto/{id}

path id: long.

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

Voltar ao índice

GET /api/Arquivo/DownloadArquivosOrdemServico/{id}

path id: long.

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

Voltar ao índice

POST /api/Arquivo/DownloadArquivosPorIds

body ids: List<long>.

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

Voltar ao índice

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

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

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

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

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

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

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

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

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

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

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

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

PUT /api/Arquivo/{id}

path id: long; body model: EditarPropriedadeInputDTO — EditarPropriedadeInputDTO.

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

Voltar ao índice

DELETE /api/Arquivo/{id}

path id: long.

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

Voltar ao índice

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

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

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

GET /api/Etiqueta/{id}

path id: long.

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

Voltar ao índice

POST /api/Etiqueta

body model: EtiquetaInputDTO — EtiquetaInputDTO.

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

Voltar ao índice

PUT /api/Etiqueta/{id}

path id: long; body model: EditarPropriedadeInputDTO — EditarPropriedadeInputDTO.

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

Voltar ao índice

DELETE /api/Etiqueta/{id}

path id: long.

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

Voltar ao índice

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

Pendências — Pendencia

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

GET /api/Pendencia

query filtro: FiltroPendenciaInputDTO — FiltroPendenciaInputDTO; query pagingParams: PagingParams.

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

Voltar ao índice

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

GET /api/Pendencia/Summary

query filtro: FiltroPendenciaInputDTO — FiltroPendenciaInputDTO.

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

Voltar ao índice

GET /api/Pendencia/PorTitulo

query filtro: FiltroPendenciaInputDTO — FiltroPendenciaInputDTO.

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

Voltar ao índice

GET /api/Pendencia/Cadencias

query filtro: FiltroPendenciaInputDTO — FiltroPendenciaInputDTO; query pagingParams: PagingParams.

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

Voltar ao índice

GET /api/Pendencia/LogEnvios

query filtro: FiltroPendenciaInputDTO — FiltroPendenciaInputDTO; query pagingParams: PagingParams.

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

Voltar ao índice

POST /api/Pendencia/{id}/CancelarCadencia

path id: long.

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

Voltar ao índice

POST /api/Pendencia/{id}/PularLembrete

path id: long.

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

Voltar ao índice

POST /api/Pendencia/{id}/Reprocessar

path id: long.

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

Voltar ao índice

POST /api/Pendencia/ReprocessarLote

query filtro: FiltroPendenciaInputDTO — FiltroPendenciaInputDTO.

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

Voltar ao índice

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

POST /api/Pendencia

body model: CriarPendenciaInputDTO — CriarPendenciaInputDTO.

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

Voltar ao índice

POST /api/Pendencia/PreviewMensagemIA

body model: PreviewMensagemIAInputDTO — PreviewMensagemIAInputDTO.

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

Voltar ao índice

PUT /api/Pendencia/{id}/Editar

path id: long; body model: EditarPendenciaInputDTO — EditarPendenciaInputDTO.

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

Voltar ao índice

PUT /api/Pendencia/{id}

path id: long; body model: EditarPropriedadeInputDTO — EditarPropriedadeInputDTO.

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

Voltar ao índice

DELETE /api/Pendencia/{id}

path id: long.

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

Voltar ao índice

POST /api/Pendencia/Resolver/{id}

path id: long; body model: ResolverPendenciaInputDTO — ResolverPendenciaInputDTO.

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

Voltar ao índice

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

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

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

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

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

GET /api/AbaComplementar/OrdemServico/AllOrdens

query filtro: FiltroOrdemServicoInputDTO — FiltroOrdemServicoInputDTO; query pagingParams: PagingParams.

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

Voltar ao índice

POST /api/AbaComplementar/OrdemServico

body dto: OrdemServicoInputDTO — OrdemServicoInputDTO.

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

Voltar ao índice

POST /api/AbaComplementar/OrdemServico/Bulk

body dto: List<OrdemServicoInputDTO> — OrdemServicoInputDTO.

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

Voltar ao índice

PUT /api/AbaComplementar/OrdemServico/{id}

path id: long; body dto: EditarPropriedadeInputDTO — EditarPropriedadeInputDTO.

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

Voltar ao índice

POST /api/AbaComplementar/OrdemServico/AlterarStatusEmLote

body dto: AlterarStatusOrdemServicoEmLoteInputDTO — AlterarStatusOrdemServicoEmLoteInputDTO.

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

Voltar ao índice

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

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

path id: long.

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

Voltar ao índice

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

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

path id: long.

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

Voltar ao índice

POST /api/AbaComplementar/OrdemServico/EmitirNota

body model: EmitirDeOrdemServicoInputDTO — EmitirDeOrdemServicoInputDTO.

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

Voltar ao índice

GET /api/AbaComplementar/OrdemServico/AFaturar

query filtro: FiltroOrdemServicoAFaturarInputDTO — FiltroOrdemServicoAFaturarInputDTO; query pagingParams: PagingParams.

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

Voltar ao índice

GET /api/AbaComplementar/OrdemServico/AFaturar/Resumo

query filtro: FiltroOrdemServicoAFaturarInputDTO — FiltroOrdemServicoAFaturarInputDTO.

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

Voltar ao índice

GET /api/AbaComplementar/OrdemServico/Erp

query filtro: FiltroOrdemServicoErpInputDTO — FiltroOrdemServicoErpInputDTO; query pagingParams: PagingParams.

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

Voltar ao índice

GET /api/AbaComplementar/OrdemServico/Erp/Resumo

query filtro: FiltroOrdemServicoErpInputDTO — FiltroOrdemServicoErpInputDTO.

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

Voltar ao índice

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

POST /api/AbaComplementar/OrdemServico/Faturar

body model: FaturarOrdemServicoInputDTO — FaturarOrdemServicoInputDTO.

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

Voltar ao índice

POST /api/AbaComplementar/OrdemServico/FaturarEmLote

body model: FaturarOrdemServicoEmLoteInputDTO — FaturarOrdemServicoEmLoteInputDTO.

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

Voltar ao índice

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

path id: long.

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

Voltar ao índice

GET /api/AbaComplementar/OrdemServico/AgrupadoPor

query grupo: GrupoOrdemServico; query filtro: FiltroOrdemServicoInputDTO — FiltroOrdemServicoInputDTO; query pagingParams: PagingParams.

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

Voltar ao índice

GET /api/AbaComplementar/OrdemServico/Mapa

query filtro: FiltroOrdemServicoInputDTO — FiltroOrdemServicoInputDTO.

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

Voltar ao índice

GET /api/AbaComplementar/OrdemServico/Summary

query filtro: FiltroOrdemServicoInputDTO — FiltroOrdemServicoInputDTO.

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

Voltar ao índice

POST /api/AbaComplementar/OrdemServico/VerificarConflito

body dto: VerificarConflitoOrdemServicoInputDTO — 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

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

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

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

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

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

POST /api/AbaComplementar/OrdemServico/CalcularRotaOtimizada

body dto: CalculateOptimizedServiceOrdersRouteInputDTO — 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

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

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

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

GET /api/AbaComplementar/Instalacao/Geral

query filtro: FiltroInstalacoesInputDTO — FiltroInstalacoesInputDTO; query pagingParams: PagingParams.

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

Voltar ao índice

GET /api/AbaComplementar/Instalacao/Summary

query filtro: FiltroInstalacoesInputDTO — FiltroInstalacoesInputDTO.

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

Voltar ao índice

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

POST /api/AbaComplementar/Instalacao

body dto: InstalacaoInputDTO — InstalacaoInputDTO.

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

Voltar ao índice

PUT /api/AbaComplementar/Instalacao

query id: long; body dto: EditarPropriedadeInputDTO — EditarPropriedadeInputDTO.

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

Voltar ao índice

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

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

path id: long.

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

Voltar ao índice

POST /api/AbaComplementar/Instalacao/diario

body dto: DiarioObraInputDTO — DiarioObraInputDTO.

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

Voltar ao índice

PUT /api/AbaComplementar/Instalacao/diario/{id}

path id: long; body dto: EditarPropriedadeInputDTO — EditarPropriedadeInputDTO.

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

Voltar ao índice

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

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

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

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

POST /api/EquipeTecnica

body model: AddEquipeInputDTO — AddEquipeInputDTO.

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

Voltar ao índice

PUT /api/EquipeTecnica/{id}

path id: long; body model: EditarPropriedadeInputDTO — EditarPropriedadeInputDTO.

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

Voltar ao índice

DELETE /api/EquipeTecnica/{id}

path id: long.

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

Voltar ao índice

POST /api/EquipeTecnica/AdicionarHorario/{id}

path id: long; query model: AddHorarioInputDTO — AddHorarioInputDTO.

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

Voltar ao índice

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

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

GET /api/TipoServico/{id}

path id: long.

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

Voltar ao índice

POST /api/TipoServico

body model: NomeInputDto — NomeInputDto.

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

Voltar ao índice

PUT /api/TipoServico/{id}

path id: long; body model: EditarPropriedadeInputDTO — EditarPropriedadeInputDTO.

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

Voltar ao índice

DELETE /api/TipoServico/{id}

path id: long.

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

Voltar ao índice

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

POST /api/TipoServico/Duplicar/{id}

path id: long; body model: DuplicarTipoServicoInputDTO — DuplicarTipoServicoInputDTO.

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

Voltar ao índice

POST /api/TipoServico/CopiarCamposPersonalizados

body body: CopiarCamposPersonalizadosInputDTO — CopiarCamposPersonalizadosInputDTO.

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

Voltar ao índice

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

GET /api/StatusOrdemServico/{id}

path id: long.

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

Voltar ao índice

POST /api/StatusOrdemServico

body model: NomeInputDto — NomeInputDto.

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

Voltar ao índice

PUT /api/StatusOrdemServico/{id}

path id: long; body model: EditarPropriedadeInputDTO — EditarPropriedadeInputDTO.

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

Voltar ao índice

DELETE /api/StatusOrdemServico/{id}

path id: long.

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

Voltar ao índice

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

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; query pagingParams: PagingParams.

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

Voltar ao índice

POST /api/RotaEntrega/Pendencias/GerarReposicao

body model: GerarReposicaoInputDTO — GerarReposicaoInputDTO.

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

Voltar ao índice

GET /api/RotaEntrega

query filtro: QueryFiltroInputDTO — QueryFiltroInputDTO; query pagingParams: PagingParams.

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

Voltar ao índice

GET /api/RotaEntrega/Minhas