Skip to main content

UAUWeb (Globaltec)

ERP para construção civil. Permite consultar informações de clientes, contratos, boletos, entre outros recursos.

UAUWeb (Globaltec) Logo

Authentication​

This connector uses Token-based authentication.

info

Set up your connection in the Abstra Console before using it in your workflows.

How to use​

Using the Smart Chat​

Execute the action "CHOOSE_ONE_ACTION_BELOW" from my connector "YOUR_CONNECTOR_NAME" using the params "PARAMS_HERE".

Using the Web Editor​

from abstra.connectors import run_connection_action

result = run_connection_action(
connection_name="your_connection_name",
action_name="your_action_name",
params={
"param1": "value1",
"param2": "value2"
})

Available Actions​

This connector provides 432 actions:

ActionPurposeParameters
post_api_v1_acompanhamento_contrato_venda_gravar_acompanhamentoDefinição Técnica: 1. Autenticar o usuário cliente URI + /api/vversion/Autenticador/AutenticarUsuario 2. Preencher os parâmetros de request para uso do método. 3. Retorna json com as informações de empresa, obra, número do contrato e número do acompanhamento. Definição de Negócio: 1. Permite inserir ou alterar um acompanhamento de contrato de venda. 2. O usuário autenticado deve ter permissão de inclusão ou alteração em OBACOMPVENDA, a depender do objetivo inserir ou editar acompanhamendata: {
. NumAcompanhamento (integer)
. Empresa (integer)
. Obra (string)
. NumContrato (string)
. PeriodoInicio (string)
. PeriodoFim (string)
. ListaDeProdutos (array)
. Responsavel (integer)
. Status (integer)
. ObservacaoParaEntrega (string)
. Motorista (integer)
. CaminhaoPlaca (string)
. UFPlaca (string)
. LocalPrestacaoServico (integer)
} (object) required
post_api_v1_acompanhamentos_servicos_acompanhar_contratoDefinição Técnica: 1. Autenticar o usuário cliente URI + /api/vversion/Autenticador/AutenticarUsuario 2. Preencher os parâmetros de request para uso do método. Definição de Negócio: Grava o acompanhamento de contrato vinculado a um planejamento ou orçamento 1. Informar os parâmetros dependendo do vinculo com orçamento ou planejamentodata: {
. empresa (string)
. obra (string)
. produto (integer)
. contrato (integer)
. item (string)
. servico (string)
. descricaoServico (string)
. mes (string)
. dataInicio (string)
. dataFim (string)
. usuario (string)
. qtde (number)
. sequencia (string)
. codigoEstrutura (string)
. orcamento (integer)
. contratoVinculado (integer)
. ordem (integer)
. etapa (string)
. observacao (string)
. aplicacaoMaterial (array)
} (object) required
post_api_v1_acompanhamentos_servicos_acompanhar_servico_plDefinição Técnica: 1. Autenticar o usuário cliente URI + /api/vversion/Autenticador/AutenticarUsuario 2. Preencher os parâmetros de request para uso do método. Definição de Negócio: Acompanhar serviço do planejamento solicitado. 1. Valida se o usuário está cadastrado no sistema e ativo. 2. Valida se já existe acompanhamento para o código externo de integração solicitado. 3. Verifica se o fechamento do acompanhamento não foi realizado.data: {
. empresa (string)
. obra (string)
. produto (integer)
. contrato (integer)
. item (string)
. servico (string)
. mes (string)
. usuario (string)
. qtde (number)
. sequencia (string)
. codExternoIntegracao (string)
. aprovaContrato (boolean)
. contratoVinculado (integer)
. descricaoServico (string)
. ordem (integer)
. etapa (string)
. observacao (string)
} (object) required
post_api_v1_acompanhamentos_servicos_acompanhar_servico_orcadoDefinição técnica: 1. Autenticar o usuário cliente URI + /api/vversion/Autenticador/AutenticarUsuario 2. Preencher os parâmetros de request para uso do método. Definição de negócio: Permite consultar e portanto acompanhar os serviços que foram orçados de acordo com os parâmentros passados na requisição. 1. Deve montar uma estrutura seguindo o modelo. 2. Valida se o usuário está cadastrado. 3. Valida se o serviço não possui estruturas. 4. Valida se possui distribuição no periodo acompandata: {
. empresa (integer)
. obra (string)
. servico (string)
. item (string)
. orcamento (integer)
. periodo (string)
. quantidade (number)
. usuario_logado (string)
. sequencia (string)
. codExternoIntegracao (string)
. aprovaContrato (boolean)
. contratoVinculado (integer)
. descricaoServico (string)
. ordem (integer)
. etapa (string)
. mes (string)
. produto (integer)
. contrato (integer)
. observacao (string)
} (object) required
post_api_v1_acompanhamentos_servicos_acompanhar_servico_contratoDefinição Técnica: 1. Autenticar o usuário cliente URI + /api/vversion/Autenticador/AutenticarUsuario 2. Preencher os parâmetros de request para uso do método do acordo com o modelo. Definição de Negócio: Permite consultar e portanto acompanhar serviços referentes aos contratos. 1. Valida usuário. 2. Valida prazo de validade do contrato.data: {
. empresa (integer)
. obra (string)
. contrato_servico (integer)
. item_contrato (integer)
. servico (string)
. data_inicio (string)
. data_fim (string)
. mes_pl (string)
. quantidade (number)
. porcentagem_acomp (number)
. observacoes (string)
. etapa (string)
. cod_estrutura (string)
. sequencia (string)
. usuario_logado (string)
. cod_acomp (number)
. orcamento (integer)
. itemOrcamento (string)
. aplicacaoMaterial (array)
} (object) required
post_api_v1_acompanhamentos_servicos_acompanhar_servico_orcado_em_loteDefinição técnica: 1. Autenticar o usuário cliente URI + /api/vversion/Autenticador/AutenticarUsuario 2. Preencher os parâmetros de request para uso do método. Definição de Negócio: Acompanhar vários serviços do orçamento.data: {
. empresa (integer)
. obra (string)
. orcamento (integer)
. usuario_logado (string)
. servicos (array)
} (object) required
post_api_v1_acompanhamentos_servicos_excluir_acompanhamento_servico_plDefinição Técnica: Permite excluir acompanhamento de Serviços do planejamento. 1. Autenticar o usuário cliente URI + /api/vversion/Autenticador/AutenticarUsuario 2. Preencher os parâmetros de request para uso do método. Definição de Negócio: Acompanhar serviço do planejamento solicitado. 1. Valida se existe acompanhamento para o código informado. 2. Valida se existe acompanhamento para o registro informado. 3. Valida se o acompanhamento se encontra aberto. 4. Valida a quantidade infodata: {
. empresa (string)
. obra (string)
. produto (integer)
. contrato (integer)
. item (string)
. servico (string)
. mes (string)
. usuario (string)
. qtde (number)
. sequencia (string)
. codExternoIntegracao (string)
} (object) required
post_api_v1_acompanhamentos_servicos_acompanhar_servico_contrato_em_loteDefinição Técnica: 1. Autenticar o usuário cliente URI + /api/vversion/Autenticador/AutenticarUsuario 2. Preencher os parâmetros de request para uso do método do acordo com o modelo. Definição de Negócio: Permite acompanhar vários serviços referentes ao contrato. 1. Valida usuário. 2. Valida prazo de validade do contrato.data: {
. empresa (integer)
. obra (string)
. contrato_servico (integer)
. usuario_logado (string)
. servicos (array)
} (object) required
post_api_v1_acompanhamentos_servicos_excluir_acompanhamento_servico_orcadoDefinição Técnica: 1. Autenticar o usuário cliente URI + /api/vversion/Autenticador/AutenticarUsuario 2. Preencher os parâmetros de request para uso do método. Definição de Negócio: Permite excluir acompanhamento de serviço orçado. 1. Valida se a exclusão pode ser realizada.data: {
. empresa (integer)
. obra (string)
. servico (string)
. item (string)
. orcamento (integer)
. periodo (string)
. quantidade (number)
. sequencia (string)
. numAcomp (integer)
. codExternoIntegracao (string)
} (object) required
post_api_v1_acompanhamentos_servicos_alterar_acompanhamento_servico_contratoDefinição técnica: 1. Autenticar o usuário cliente URI + /api/vversion/Autenticador/AutenticarUsuario 2. Preencher os parâmetros de request para uso do método. Definição de negócio: Permite consultar e portanto acompanhar os serviços que foram orçados de acordo com os parâmentros passados na requisição. 1. Deve montar uma estrutura seguindo o modelo. 2. Valida se o usuário é cadastrado e se tem permissão para realizar a alteração. 3. Valida se o serviço é controlado por tipologia de prodata: {
. empresa (integer)
. obra (string)
. contrato_servico (integer)
. item_contrato (integer)
. servico (string)
. data_inicio (string)
. data_fim (string)
. mes_pl (string)
. quantidade (number)
. porcentagem_acomp (number)
. observacoes (string)
. etapa (string)
. cod_estrutura (string)
. sequencia (string)
. usuario_logado (string)
. cod_acomp (number)
. orcamento (integer)
. itemOrcamento (string)
. aplicacaoMaterial (array)
} (object) required
post_api_v1_acompanhamentos_servicos_excluir_acompanhamento_servico_de_contratoDefinição Técnica: 1. Autenticar o usuário cliente URI + /api/vversion/Autenticador/AutenticarUsuario 2. Preencher os parâmetros de request para uso do método. Definição de Negócio: Exclui o acompanhamento de serviço no contrato. 1. Valida se o usuário tem permissão para excluir um acompanhamento. 2. Valida se possui estrutura e se o status do acompanhamento está como 'aberto'. Neste caso não será excluido.data: {
. empresa (integer)
. contrato_servico (integer)
. item_contrato (integer)
. servico (string)
. quantidade (number)
. sequencia (string)
. codigo_estrutura (string)
. usuario_logado (string)
. codAec (integer)
} (object) required
post_api_v1_acompanhamentos_servicos_excluir_acompanhamento_servico_orcado_em_loteDefinição Técnica: 1. Autenticar o usuário cliente URI + /api/vversion/Autenticador/AutenticarUsuario 2. Preencher os parâmetros de request para uso do método. Definição de Negócio: Permite excluir acompanhamento de vários serviços orçados. 1. Valida se a exclusão pode ser realizada.data: {
. empresa (integer)
. obra (string)
. orcamento (integer)
. avancos (array)
} (object) required
post_api_v1_acompanhamentos_servicos_excluir_acompanhamento_servico_orcado_por_chaveDefinição Técnica: 1. Autenticar o usuário cliente URI + /api/vversion/Autenticador/AutenticarUsuario 2. Preencher os parâmetros de request para uso do método. Definição de Negócio: Exclui o acompanhamento de serviço oraçado de acordo com a chave informada. 1. Valida se o acompanhamento informado existe. 2. Valida se a exclusão pode ser realizada.data: {
. empresa (integer)
. obra (string)
. servico (string)
. item (string)
. orcamento (integer)
. periodo (string)
. quantidade (number)
. sequencia (string)
. numAcomp (integer)
. codExternoIntegracao (string)
} (object) required
post_api_v1_acompanhamentos_servicos_excluir_acompanhamento_servico_de_contrato_em_loteDefinição Técnica: 1. Autenticar o usuário cliente URI + /api/vversion/Autenticador/AutenticarUsuario 2. Preencher os parâmetros de request para uso do método. Definição de Negócio: Exclui o acompanhamento de vários serviços no contrato. 1. Valida se o usuário tem permissão para excluir um acompanhamento. 2. Valida se possui estrutura e se o status do acompanhamento está como 'aberto'. Neste caso não será excluido.data: {
. empresa (integer)
. contrato_servico (integer)
. usuario_logado (string)
. avancos (array)
} (object) required
post_api_v1_acompanhamentos_servicos_consultar_acompanhamento_contrato_servico_por_servicoDefinição Técnica: 1. Autenticar o usuário cliente URI + /api/vversion/Autenticador/AutenticarUsuario 2. Preencher os parâmetros de request para uso do método. Definição de Negócio: Consulta acompanhamento de contrato de serviço filtrando por serviço.data: {
. Empresa (integer)
. Servico (string)
} (object) required
post_api_v1_acompanhamentos_servicos_consultar_acompanhamento_contrato_servico_por_contrato_eservicoDefinição Técnica: 1. Autenticar o usuário cliente URI + /api/vversion/Autenticador/AutenticarUsuario 2. Preencher os parâmetros de request para uso do método. Definição de Negócio: Permite acompanhar contratos filtrando por: - Empresa - Contrato - Serviçodata: {
. Empresa (integer)
. Contrato (integer)
. Servico (string)
} (object) required
post_api_v1_acompanhar_entrega_consultar_processosDefinição Técnica: 1. Autenticar o usuário cliente URI + /api/vversion/Autenticador/AutenticarUsuario 2. Preencher os parâmetros de request para uso do método. Regras Básicas: 1. Retorna os processos e itens que estão com o acompanhamento de entrega pendente para uma dada empresa e obra informada.data: {
. empresa (integer)
. obra (string)
} (object) required
post_api_v1_acompanhar_entrega_acompanhar_pre_entregaDefinição Técnica: 1. Autenticar o usuário cliente URI + /api/vversion/Autenticador/AutenticarUsuario 2. Preencher os parâmetros de request para uso do método. Regras Básicas: 1. O usuário deve possuir acesso na empresa e obra informada. 2. O usuário deve possuir permissão de alteração no programa FIANALISE. 3. O número do processo deve ser um processo existente. 4. A NF e NF de frete devem ser númericos e válidos. 5. O código de barras deve ser númerico e possuir no mínimodata: {
. Empresa (integer)
. Obra (string)
. Processo (integer)
. ChaveNotaFiscal (string)
. ChaveNotaFiscalFrete (string)
. CodigoDoBoleto (string)
. CodigoDoBoletoFrete (string)
. Itens (array)
} (object) required
post_api_v1_anexo_anexar_arquivoDefinição Técnica: 1. Autenticar o usuário cliente URI + /api/vversion/Autenticador/AutenticarUsuario 2. Preencher os parâmetros de request para uso do método. Definição de Negócio: 1. Anexa arquivo dentro do UAU, utilizando a chave identificadora para fazer o vinculo desse arquivo com algum parametro dentro do sistema. Parâmetros da request 1. arquivo: Conteúdo do arquivo em base 64 2. nome: Nome do arquivo 3. caminho: Caminho do arquivo 4. identificador: Chave identificadora do adata: {
. arquivo (string)
. nome (string)
. caminho (string)
. identificador (string)
. usuario (string)
. caminhoExclusivo (string)
. controlaAnexoUAUWeb (boolean)
} (object) required
post_api_v1_anexo_excluir_anexosDefinição Técnica: 1. Autenticar o usuário cliente URI + /api/vversion/Autenticador/AutenticarUsuario 2. Preencher os parâmetros de request para uso do método. Parâmetros da request 1. identificador: Chave identificadora do arquivo no formato 'STRING STRING'. 2. nome_arquivo: Nome do arquivo + extensão. Exemplo: nomeDoArquivo.png 3. origem: Indica o tipo de armazenamento será utilizado para excluir o vinculo ao arquivo. Pode ser 1-Local ou 2-AWS S3. Caso não informe será obtidodata: {
. identificador (string)
. nome_arquivo (string)
. origem (integer)
} (object) required
post_api_v1_anexo_baixar_arquivosbDefinição Técnica:/b list type='number' itemAutenticar o usuário cliente via URI: /api/vversion/Autenticador/AutenticarUsuario/item itemPreencher os parâmetros de request para uso do método./item itemUtilizar a rota Anexo/ListaArquivoPorChave para obter os caminhos completos dos arquivos./item /list bParâmetros do Request:/b list type='bullet' item CaminhoCompleto: Caminho completo do arquivo que deverá ser compactado para ZIP./item item Origem Obrigatório: lisdata: {
. Arquivos (array)
} (object) required
post_api_v1_anexo_listar_diretoriosDEFINIÇÕES TÉCNICAS Status 200 - Retorna uma lista de diretóriosdata: {
. Caminho (string)
. Origem (integer)
} (object) required
post_api_v1_anexo_anexar_base64imagemDefinição Técnica: 1. Autenticar o usuário cliente URI + /api/vversion/Autenticador/AutenticarUsuario 2. Preencher os parâmetros de request para uso do método. Definição de Negócio: Possibilita anexar imagem no formato Base64data: {
. arquivo (string)
. nome (string)
. caminho (string)
. identificador (string)
. usuario (string)
. extensaoImagem (string)
. caminhoExclusivo (string)
. controlaAnexoUAUWeb (boolean)
. origem (integer)
} (object) required
post_api_v1_anexo_lista_arquivo_por_chavebDefinição Técnica:/b list type='number' itemAutenticar o usuário cliente via URI: /api/vversion/Autenticador/AutenticarUsuario/item itemPreencher os parâmetros de request para uso do método./item /list bParâmetros da Request:/b list type='bullet' item chave: Identificador do arquivo./item item valores: Valores identificadores do arquivo./item /list Para obter as chaves de utilização na requisição, utilize a rota: Anexo/ConsultarChavesComentariodata: {
. Chave (string)
. Valores (array)
} (object) required
post_api_v1_anexo_listar_armazenamentosRetorna a lista de armazenamentos ativosNo parameters
post_api_v1_anexo_gravar_comentario_anexoDefinição técnica: - Adiciona comentário anexo de acordo com os parâmetros passados na requisição. Pré requisito: - Verifique o endpoint abaixo para obter informações dos parametros de entrada aceitos: - URL + /api/vversion/Anexo/ConsultarChavesComentario Parâmetros da request 1. Chave: Chave para consulta. 2. Campos: Campos obrigatórios para a chave='Venda' empresa, obra, venda. Campos obrigatórios para a chave='Contrato' Empresa, Contrato Deve ser inserido juntos, separadosdata: {
. Chave (string)
. Campos (string)
. Usuario (string)
. Comentario (string)
. TipoComentario (string)
. UsuarioPrivado (array)
. GrupoPrivado (array)
} (object) required
post_api_v1_anexo_retorna_arquivo_em_bytesEm Modulo UAU and gt; and gt; Utilitários and gt; and gt; Configurações do sistema and gt; and gt; Em 'Arquivo' and gt; and gt; ArquivosAnexos: Esse e o caminho padrão que a rota usar na consulta para retorna o arquivo em base64. Definição Técnica: 1. Autenticar o usuário cliente URI + /api/vversion/Autenticador/AutenticarUsuario 2. Preencher os parâmetros de request para uso do método. Parâmetros da request 1. nome_arquivo: Nome do arquivo + extensão. Exemplo: nomeDoArquivo.pndata: {
. nome_arquivo (string)
. origem (integer)
} (object) required
post_api_v1_anexo_consultar_chaves_comentarioDefinição técnica: - Este endpoint oferece suporte para o seguinte endpoint: URI + /api/vversion/Anexo/GravarComentarioAnexo - Retorna objetos com: - Possíveis chaves que podem ser utilizadas. - Ordem dos parâmetros aceitos. - Exemplo de utilização e formatação dos parâmetros. Anexos: - Exemplo Postman: https://ajuda.globaltec.com.br/download/777152/No parameters
post_api_v1_anexo_anexar_arquivos_base64requestDefinição técnica: - Realiza o anexo de um arquivo de acordo com os parâmetros enviados na requisição. Pré requisito: - Verifique o endpoint abaixo para obter informações dos parametros de entrada aceitos: - URL + /api/vversion/Anexo/ConsultarChavesComentario Parâmetros da request: 1. Arquivo: Conteúdo do arquivo em Base64 sem prefixos. 2. Nome: Nome do arquivo. 3. Caminho: Caminho de armazenamento do arquivo. 4. Identificador: Chave identificadora no formato 'STRING STRING'. Exdata: {
. lista_arquivos (array)
. empresa (integer)
. usuario (string)
} (object) required
post_api_v1_anexo_retornar_arquivos_em_lista_bytesBaseado no ‘’código identificador do documento’’ passado ele já retorna os arquivos tanto disponível localmente e na nuvem, sem a necessidade de passar o parâmetro “origem” no body do request. Definição Técnica: 1. Autenticar o usuário cliente URI + /api/vversion/Autenticador/AutenticarUsuario 2. Preencher os parâmetros de request para uso do método. Parâmetros da request 1. empresa: Número da empresa. 2. identificador: Chave identificadora do arquivo no formato 'STRINdata: {
. empresa (string)
. identificador (string)
. listanomes_arquivos (array)
} (object) required
post_api_v1_atendimento_gerar_pendenciaDefinição Técnica: 1. Autenticar o usuário cliente URI + /api/vversion/Autenticador/AutenticarUsuario 2. Preencher os parâmetros de request para uso do método.data: {
. usuariouau_destino (string)
. data_prevista (string)
. data_aviso (string)
. hora_aviso (string)
. mensagem (string)
. geraremail_interno (boolean)
. gerar_email_externo (boolean)
. gerar_aviso (boolean)
. categoria (string)
} (object) required
post_api_v1_atendimento_gravar_atendimentoDefinição Técnica: 1. Autenticar o usuário cliente URI + /api/vversion/Autenticador/AutenticarUsuario 2. Consultar os dados do usuário logado para obter o código do cliente URI + /api/vversion/Atendimento/GravarAtendimento 3. Preencher os parâmetros de request para uso do método. Definição de Negócio: Permite Gravar o Atendimento. 1. Deve montar uma estrutura com as informações do Atendimento verificando os parâmetros obrigatórios. 2. Será apenas registrado Atendimentos com o status 0 -data: {
. atendimento (object)
} (object) required
post_api_v1_atendimento_consultar_pendenciaDefinição Técnica: 1. Autenticar o usuário cliente URI + /api/vversion/Autenticador/AutenticarUsuario 2. Preencher os parâmetros de request para uso do método.data: {
. numero (integer)
. data_lancamento (string)
. responsavel_resolucao (string)
} (object) required
post_api_v1_atendimento_consultar_atendimentoDefinição Técnica: 1. Autenticar o usuário cliente URI + /api/vversion/Autenticador/AutenticarUsuario 2. Preencher os parâmetros de request para uso do método.data: {
. codigo_atendimento (integer)
} (object) required
post_api_v1_atendimento_consultar_categ_de_coment_ativasDefinição Técnica: 1. Autenticar o usuário cliente URI + /api/vversion/Autenticador/AutenticarUsuario 2. Preencher os parâmetros de request para uso do método.No parameters
post_api_v1_atendimento_consultar_pendencia_observacaoDefinição Técnica: 1. Autenticar o usuário cliente URI + /api/vversion/Autenticador/AutenticarUsuario 2. Preencher os parâmetros de request para uso do método.data: {
. numero_pendencia (integer)
. dataquando_lancou (string)
. usuario_resolve (string)
} (object) required
post_api_v1_atendimento_vincular_arquivo_ao_atendimentoDefinição Técnica: 1. Autenticar o usuário cliente URI + /api/vversion/Autenticador/AutenticarUsuario 2. Preencher os parâmetros de request para uso do método.data: {
. arquivo (string)
. nome_arquivo (string)
. num_atendimento (integer)
. usuario (string)
} (object) required
post_api_v1_atendimento_consultar_atendimento_por_pessoaDefinição Técnica: 1. Autenticar o usuário cliente URI + /api/vversion/Autenticador/AutenticarUsuario 2. Preencher os parâmetros de request para uso do método.data: {
. codigo_pessoa (integer)
} (object) required
post_api_v1_atendimento_consultar_empreendimentos_clienteDefinição Técnica: 1. Autenticar o usuário cliente URI + /api/vversion/Autenticador/AutenticarUsuario 2. Preencher os parâmetros de request para uso do método.data: {
. cod_pessoa (integer)
} (object) required
post_api_v1_atendimento_consultar_categoria_atendimento_webDefinição Técnica: 1. Autenticar o usuário cliente URI + /api/vversion/Autenticador/AutenticarUsuario 2. Preencher os parâmetros de request para uso do método.data: {
. tipo_atend (string)
} (object) required
post_api_v1_atendimento_consultar_numero_work_flow_vinculadoDefinição Técnica: 1. Autenticar o usuário cliente URI + /api/vversion/Autenticador/AutenticarUsuario 2. Preencher os parâmetros de request para uso do método.data: {
. numerovinculo_workflow (integer)
. empresa (integer)
. obra (string)
} (object) required
post_api_v1_atendimento_consultar_pendencias_por_numero_vinculoDefinição Técnica: 1. Autenticar o usuário cliente URI + /api/vversion/Autenticador/AutenticarUsuario 2. Preencher os parâmetros de request para uso do método.data: {
. numero_vinculo (integer)
} (object) required
post_api_v1_atendimento_gerar_atendimento_por_chat_online_clienteDefinição Técnica: 1. Autenticar o usuário cliente URI + /api/vversion/Autenticador/AutenticarUsuario 2. Preencher os parâmetros de request para uso do método.data: {
. dados_atendimento (object)
} (object) required
post_api_v1_atendimento_consultar_atendimento_detalhado_por_chaveDefinição Técnica: 1. Autenticar o usuário cliente URI + /api/vversion/Autenticador/AutenticarUsuario 2. Preencher os parâmetros de request para uso do método.data: {
. codigo_atendimento (integer)
} (object) required
post_api_v1_atendimento_consultar_configuracao_atendimento_uauwebDefinição Técnica: 1. Autenticar o usuário cliente URI + /api/vversion/Autenticador/AutenticarUsuario 2. Preencher os parâmetros de request para uso do método.No parameters
post_api_v1_atendimento_consultar_atendimento_por_categorias_uau_webDefinição Técnica: 1. Autenticar o usuário cliente URI + /api/vversion/Autenticador/AutenticarUsuario 2. Preencher os parâmetros de request para uso do método.data: {
. codigo_pessoa (integer)
} (object) required
post_api_v1_atendimento_consultar_atendimento_por_pessoa_comentarioDefinição Técnica: 1. Autenticar o usuário cliente URI + /api/vversion/Autenticador/AutenticarUsuario 2. Preencher os parâmetros de request para uso do método.data: {
. codigo_pessoa (integer)
. lista_categoria (array)
. periodo_incio (string)
. periodo_fim (string)
} (object) required
post_api_v1_atendimento_consultar_unidades_do_empreendimento_clienteDefinição Técnica: 1. Autenticar o usuário cliente URI + /api/vversion/Autenticador/AutenticarUsuario 2. Preencher os parâmetros de request para uso do método.data: {
. obra (string)
. empresa (integer)
. cod_pessoa (integer)
} (object) required
post_api_v1_atendimento_consultar_data_prevista_de_termino_atendimentoDefinição Técnica: 1. Autenticar o usuário cliente URI + /api/vversion/Autenticador/AutenticarUsuario 2. Preencher os parâmetros de request para uso do método.data: {
. numerovinculo_workflow (integer)
. numero_workflow (integer)
} (object) required
post_api_v1_atendimento_consultar_numero_vinculo_categoria_de_comentario_com_work_flowDefinição Técnica: 1. Autenticar o usuário cliente URI + /api/vversion/Autenticador/AutenticarUsuario 2. Preencher os parâmetros de request para uso do método.data: {
. codigo_categoria (string)
} (object) required
post_api_v1_autenticador_logout_usuarioCriação: Diogo Rodrigues Gonçalves Data: 22/01/2018No parameters
post_api_v1_autenticador_autenticar_usuarioDefinição técnica: 1. Preencher os parâmetros de request para uso do método. Definição de negócio: 1. Verifica o método de Login configurado no Sistema Uau https://ajuda.globaltec.com.br/virtuau/configuracao-de-seguranca/ 2. Empresa configurada com Autenticação AD e utilizar este serviço a autenticação será como Cliente/Pessoa. 3. Empresa configurada com Autenticação Uau - Login do usuário maior que 8 caracteres a autenticação será como Cliente/Pessoa. - Login do usuário menor qudata: {
. Login (string)
. Senha (string)
. UsuarioUAUSite (string)
} (object) required
post_api_v1_autenticador_autenticar_usuario_appRealiza a autenticação do usuário e senha verificando o método de login sendo AD será autenticado o usuário corporativo, caso contrário será validado como usuário UAU ou Cliente. Atualmente utilizado pela API do Mobile.data: {
. Login (string)
. Senha (string)
. UsuarioUAUSite (string)
} (object) required
post_api_v1_autenticador_verifica_usuario_logadoVerifica se um usuário está logadoNo parameters
post_api_v1_autenticador_consultar_dados_usr_logadoDefinição Técnica: 1. Autenticar o usuário cliente URI + /api/vversion/Autenticador/AutenticarUsuario Definição de Negócio: Permite consultar os dados do usuário do tipo cliente do Cadastro de Pessoas do Uau. 1. O usuário cliente deve estar autenticado. 2. Retorna as informações do cliente logado, conforme a estrutura abaixo. - Estrutura do Retorno: https://ajuda.globaltec.com.br/download/774818/ 3. Dados Pessoais: - codigo = Código do cliente - nome = Nome completo -No parameters
post_api_v1_autenticador_autentificar_usuario_titaniumFaz a autenticação de um usuário titaniumdata: {
. usuario (string)
. senha (string)
} (object) required
post_api_v1_autenticador_autenticar_usuario_corporativoDefinição técnica: 1. Preencher os parâmetros de request para uso do método. Definição de negócio: 1. Verifica o método de Login configurado no Sistema Uau https://ajuda.globaltec.com.br/virtuau/configuracao-de-seguranca/ 2. Empresa configurada para método de Login Uau via banco de dados - Será realizada a verificação se existe o usuário com a senha informada. 3. Empresa configurada para método de Login via AD - Será realizada a autenticação validando no Active Directory 4. No pdata: {
. login_ad (string)
. senha (string)
. login_uau (string)
} (object) required
post_api_v1_banco_horas_lancar_banco_horas_funcionarioDefinição Técnica: 1. Autenticar o usuário cliente URI + /api/vversion/Autenticador/AutenticarUsuario 2. Preencher os parâmetros de request para uso do endpoint. Definição de Negócio: 1. Gravar lançamento de horas no banco de horas para o funcionário.data: {
. ListaBancoHoras (array)
} (object) required
post_api_v1_boleto_services_gerar_pdfcarneDefinição Técnica: 1. Autenticar o usuário cliente URI + /api/vversion/Autenticador/AutenticarUsuario 2. Preencher os parâmetros de request com os dados do usuário para uso do método. 3. O retorno será um base64. Para poder visualizar os carnês, é necessário fazer uma conversão para PDF. Regras de Negócio: 1. Para realizar a requisição, informar apenas um filtro. Caso o filtro de chaves do boleto for informado, o filtro de venda remessa, não deve ser informado. O mesmo para o caso contrárdata: {
. filtroChavesBoleto (array)
. filtroVendaRemessa (object)
. CarneTresBoletosPaginaNaVertical (boolean)
. CarneDoisBoletosPaginaNaHorizontal (boolean)
} (object) required
post_api_v1_boleto_services_gerar_pdfboletoDefinição Técnica: 1. Autenticar o usuário cliente URI + /api/vversion/Autenticador/AutenticarUsuario 2. Preencher os parâmetros de request para uso do método. 3. Utilize em conversor de string Base64 para PDF. Definição de Negócio: Permite gerar boleto. 1. O parâmetro booleano true ou false 'ocultar_dados_pessoais' determina se br / os dados pessoais do cliente nome completo e endereço serão exibidos no PDF do boleto gerado. 2. O parâmetro inteiro 'cod_banco' deve ser informado semdata: {
. cod_banco (integer)
. seu_numero (integer)
. ocultar_dados_pessoais (boolean)
} (object) required
post_api_v1_boleto_services_obter_codigo_de_barrasDefinição Técnica: 1. Autenticar o usuário cliente URI + /api/vversion/Autenticador/AutenticarUsuario 2. Preencher os parâmetros de request para uso do método. Definição de Negócio: 1. Busca o número do código de barras do boleto informado. 2. Caso boleto que deseja consultar seja gerado via intermediário digital informar: código do banco e seu númerodata: {
. cod_banco (string)
. seu_numero (string)
. data_venc (string)
. valor_nominal (number)
. campo_livre (string)
} (object) required
post_api_v1_boleto_services_obter_linha_digitavelDefinição Técnica: 1. Autenticar o usuário cliente URI + /api/vversion/Autenticador/AutenticarUsuario 2. Preencher os parâmetros de request para uso do método. Definição de Negócio: 1. Consulta a linha digitável do código de barras.data: {
. codigode_barras (string)
} (object) required
post_api_v1_boleto_services_alterar_data_vencimentoDefinição técnica: 1. Autenticar o usuário cliente URI + /api/vversion/Autenticador/AutenticarUsuario 2. Preencher os parâmetros de request para uso do método. Definição de negócio: Permite alterar a data de vencimento de um boleto cadastrado no UAU. 1. Não é permitido alterar a data de vencimento para um boleto excluído. 2. Não é permitido alterar a data de vencimento para um boleto antecipado. 3. Não é permito alterar data de vencimento de um boleto gerado via intermediario digital. 4data: {
. seuNumero (integer)
. codBanco (integer)
. codEmpresa (integer)
. novaDataVenc (string)
} (object) required
post_api_v1_boleto_services_consultar_status_boletoDefinição Técnica: 1. Autenticar o usuário cliente URI + /api/vversion/Autenticador/AutenticarUsuario 2. Preencher os parâmetros de request para uso do método. Definição de Negócio: 1. Possibilita consulta status do boleto.data: {
. codigoBanco (integer)
. seuNumero (integer)
} (object) required
post_api_v1_boleto_services_obter_mensagem_do_boletoDefinição Técnica: 1. Autenticar o usuário cliente URI + /api/vversion/Autenticador/AutenticarUsuario 2. Preencher os parâmetros de request para uso do método. Definição de Negócio: 1. Consulta a mensagem do boleto informado nos parâmetros da request.data: {
. seu_numero (integer)
. cod_banco (integer)
. cod_empresa (integer)
. instrucao (string)
. carteira (string)
} (object) required
post_api_v1_boleto_services_consultar_dados_do_boletoDefinição Técnica: 1. Autenticar o usuário cliente URI + /api/vversion/Autenticador/AutenticarUsuario 2. Preencher os parâmetros de request para uso do método. Definição de Negócio: 1. Consulta informações contidas no boleto.data: {
. cod_banco (string)
. seu_numero (string)
} (object) required
post_api_v1_boleto_services_consultar_boletos_do_clienteDefinição Técnica: 1. Autenticar o usuário cliente URI + /api/vversion/Autenticador/AutenticarUsuario 2. Preencher os parâmetros de request para uso do método. 3. Consulta ou não boletos vencidos. Definição de Negócio: Consulta boletos por cliente. 1. Consulta boletos por cliente. 2. Ao definir que não irá mostrar boletos vencidos, serão retornados apenas os boletos a vencer. 3. Ao definir que deve mostrar boletos vencidos, serão retornados boletos vencidos e a vencer. 4. Parcelas qdata: {
. codPessoa (integer)
. naoMostraBoletoVencido (boolean)
. usuario (string)
. tipo_usuario (integer)
} (object) required
post_api_v1_boleto_services_consultar_boletos_reimpressaoDefinição Técnica: 1. Autenticar o usuário cliente URI + /api/vversion/Autenticador/AutenticarUsuario 2. Preencher os parâmetros de request para uso do método. Definição de Negócio: Consultar boletos disponíveis para reimpressão. 1. Valida usuário logado do tipo pessoa/cliente. 2. Valida código do usuário. 3. Parcelas que possuem mais de um boleto ativo, não terão os boletos trazidos na consulta, devido a quem for obter/utilizar o retorno, não saber qual dos boletos deve ser impressdata: {
. empresa (integer)
. obra (string)
. num_venda (integer)
. naomostraboleto_vencido (boolean)
. mostrarApenasUltimoBoleto (boolean)
} (object) required
get_api_v1_cessao_recebiveis_consultar_contratobDefinição Técnica:/b brDados básicos para o funcionamento da API./br list type='bullet' item1. Autenticar o usuário cliente: URI + /api/vversion/Autenticador/AutenticarUsuario/item /list bDefinição de Negócio:/b brConsultar um contrato de cessão de recebíveis./br list type='bullet' item1. É obrigatório informar ao menos um dos parâmetros da rota para realizar a busca./item item2. A data pode ser informada no padrão Dia/Mês/Ano./item item3. O comprador, deve ser informado o códdataContrato (string)
nomeContrato (string)
comprador (string)
chaveVenda (string)
mostraHistorico (string)
post_api_v1_cessao_recebiveis_aprovar_contratobDefinição Técnica:/b brDados básicos para o funcionamento da API./br list type='bullet' item1. Autenticar o usuário cliente: URI + /api/vversion/Autenticador/AutenticarUsuario/item item2. Preencher os parâmetros de request para uso do método./item /list bDefinição de Negócio:/b brAprovar um contrato de cessão de recebíveis./br list type='bullet' item1. É obrigatório informar os dados básicos do contrasto de cessão de recebíveis./item item2. O usuário autenticado precisa ter acdata: {
. idContrato (integer)
} (object) required
post_api_v1_cessao_recebiveis_inserir_contratobDefinição Técnica:/b brDados básicos para o funcionamento da API./br list type='bullet' item1. Autenticar o usuário cliente: URI + /api/vversion/Autenticador/AutenticarUsuario/item item2. Preencher os parâmetros de request para uso do método./item /list bDefinição de Negócio:/b brInserir um contrato de cessão de recebíveis./br list type='bullet' item1. É obrigatório informar os dados básicos do contrasto de cessão de recebíveis./item item2. O usuário autenticado precisa ter acdata: {
. Contrato (string)
. Descricao (string)
. Empresa (integer)
. DataContrato (string)
. Comprador (string)
. PeriodoParcelas (object)
. Obras (array)
. ObraVenda (string)
. DataVenda (string)
. ModeloVendas (integer)
. ProdutoVenda (integer)
. ValorTotalVenda (number)
. RiscoContrato (boolean)
. PermitirRenegociacao (boolean)
. GerarVendaDoContrato (boolean)
. Parcelas (array)
. GrupoCobranca (integer)
} (object) required
post_api_v1_cessao_recebiveis_gerar_venda_do_contratobDefinição Técnica:/b brDados básicos para o funcionamento da API./br list type='bullet' item1. Autenticar o usuário cliente: URI + /api/vversion/Autenticador/AutenticarUsuario/item item2. Preencher os parâmetros de request para uso do método./item /list bDefinição de Negócio:/b brGerar a venda um contrato de cessão de recebíveis./br list type='bullet' item1. É obrigatório informar os dados básicos do contrasto de cessão de recebíveis./item item2. O usuário autenticado precisadata: {
. idContrato (integer)
} (object) required
get_api_v1_chave_pix_pessoas_consultar_by_cpf_cnpjDefinição Técnica: 1. Autenticar o usuário cliente URI + /api/vversion/Autenticador/AutenticarUsuario 2. Preencher os parâmetros de request com os dados do usuário para uso do método. Regras de Negócio: 1. É necessário que exista uma pessoa cadastrada no sistema com o CPF/CNPJ informado.cpfCnpj (string) required
post_api_v1_chave_pix_pessoas_deletarDefinição Técnica: 1. Autenticar o usuário cliente URI + /api/vversion/Autenticador/AutenticarUsuario 2. Preencher os parâmetros de request com os dados do usuário para uso do método. Regras de Negócio: 1. É necessário que exista uma pessoa cadastrada no sistema com o CPF/CNPJ informado. 2. O tipo de chave pix deve ser: 1 - Celular, 2 - E-mail, 3 - CPF/CNPJ, 4 - Chave aleatória. 3. A chave pix deve ter no máximo 77 caracteres.data: {
. cpfCnpj (string)
. chavePix (string)
. tipoChavePix (integer)
} (object) required
post_api_v1_chave_pix_pessoas_atualizarDefinição Técnica: 1. Autenticar o usuário cliente URI + /api/vversion/Autenticador/AutenticarUsuario 2. Preencher os parâmetros de request com os dados do usuário para uso do método. Regras de Negócio: 1. É necessário que exista uma pessoa cadastrada no sistema com o CPF/CNPJ informado. 2. O tipo de chave pix deve ser: 1 - Celular, 2 - E-mail, 3 - CPF/CNPJ, 4 - Chave aleatória. 3. A chave pix deve ter no máximo 77 caracteres. 4. A chave padrão deve ser: 0 - NÃO, 1 - SIM. 5. O campo atdata: {
. cpfCnpj (string)
. chavePix (string)
. tipoChavePix (integer)
. chavePixPadrao (integer)
. ativoInativo (integer)
} (object) required
post_api_v1_chave_pix_pessoas_cadastrarDefinição Técnica: 1. Autenticar o usuário cliente URI + /api/vversion/Autenticador/AutenticarUsuario 2. Preencher os parâmetros de request com os dados do usuário para uso do método. Regras de Negócio: 1. É necessário que exista uma pessoa cadastrada no sistema com o CPF/CNPJ informado. 2. O tipo de chave pix deve ser: 1 - Celular, 2 - E-mail, 3 - CPF/CNPJ, 4 - Chave aleatória. 3. A chave pix deve ter no máximo 77 caracteres. 4. A chave padrão deve ser: 0 - NÃO, 1 - SIM. 5. O campo atdata: {
. cpfCnpj (string)
. chavePix (string)
. tipoChavePix (integer)
. chavePixPadrao (integer)
. ativoInativo (integer)
} (object) required
post_api_v1_pix_pix_por_parcelasDefinição técnica: - O objetivo desta rota de API é permitir a consulta e retorno das informações dos PIX gerados para uma determinada parcela ou lista de parcelas - Serão retornados os dados do PIX, caso tenha sido gerado para as parcelas requisitadas - Limite máximo de 50 parcelas por requisiçãodata (array) required
post_api_v1_pix_reimpressao_pixDefinição técnica: - O objetivo desta rota de API é permitir a consulta e retorno das informações do pix de modo que o usuário possa fazer a impressão dos dados de cobrança. - Será retornado o PDF completo e o QRCode em base64. - Será retornado o texto do Pix Copia e Cola. Instituições bancárias suportadas: - 341 = Banco Itaú - 756 = Banco Sicoob - 237 = Banco Bradesco - 246 = Banco Abcdata: {
. TxId (string)
} (object) required
post_api_v1_pix_consultar_pix_statusDefinição técnica: - O objetivo desta rota de API e permitir a consulta do status do PIX Instituições bancárias suportadas: - 341 = Banco Itaú - 246 = Banco Abc - 341 = Banco Itaú - 756 = Banco Sicoob - 237 = Banco Bradesco Pré requisito: - Verifique o endpoint abaixo para obter informações dos parametros de entrada aceitos: - URL + /api/vversion/Pix/GerarCobrancaPIX Anexos: - Exemplo Postman: ALTERAR EXEMPLOdata (array) required
post_api_v1_pix_gerar_cobranca_vendabDefinição Técnica:/b list type='bullet' item1. O objetivo desta rota de API é permitir o registro de cobrança por PIX junto à instituição financeira./item item2. O BASE64 gerado é somente o QR Code do PIX./item item3. Instituições bancárias suportadas:/item list type='bullet' item - 341 Banco Itaú/item item - 756 Banco Sicoob/item item - 237 Banco Bradesco/item item - 246 Banco ABC/item /list /list bPré Requisitos:/b list type='bullet' item1. Verifiquedata: {
. DataDeCalculo (string)
. Antecipar (boolean)
. UsarPadraoPixAvulso (boolean)
. AgruparParcelas (boolean)
. PadraoCobranca (integer)
. Parcelas (array)
} (object) required
post_api_v1_pix_gerar_cobranca_propostaDefinição técnica: - O objetivo desta rota de API é permitir o registro de cobrança por PIX junto a instituição financeira - O BASE64 gerado é somente o QRCODE do PIX Instituições bancárias suportadas: - 341 = Banco Itaú - 756 = Banco Sicoob - 237 = Banco Bradesco - 246 = Banco Abc Pré requisito: - Verifique o endpoint abaixo para obter informações dos parametros de entrada aceitos: - URL + /api/vversion/Venda/GerarCobrancaPIXdata: {
. DataDeCalculo (string)
. Antecipar (boolean)
. UsarPadraoPixAvulso (boolean)
. AgruparParcelas (boolean)
. PadraoCobranca (integer)
. Parcelas (array)
} (object) required
post_api_v1_comissao_consultar_vendedoresDefinição Técnica: 1. Autenticar o usuário cliente URI + /api/vversion/Autenticador/AutenticarUsuario; 2. Preencher os parâmetros de request para uso do endpoint. Definição de Negócio: 1. Consulta os vendedores da estrutura de comissão; 2. Caso não seja informado o código da comissão retornará todos os vendedores relacionados à estrutura de comissão; 3. Caso seja informado um código que não esteja relacionado a estrutura de comissão o sistema retornará 'vazio'. Informação: 1. Cuidadodata: {
. codigoModeloComissao (integer)
} (object) required
post_api_v1_comissao_atualizar_status_comissaoDefinição Técnica: 1. Autenticar o usuário cliente URI + /api/vversion/Autenticador/AutenticarUsuario 2. Preencher os parâmetros de request para uso do endpoint. Definição de Negócio: 1. Alterar os status de pagamento das comissões de uma pessoabeneficiário. 2. Não é possível cancelar ou reativar status de pagamento da comissão via Endpoint. 3. Todos os campos são obrigatórios informar. 4. Os dados informados passam por validações. 5. Não é permitido marcar como 'pago' comissões que gedata (array) required
post_api_v1_comissao_consultar_modelo_comissaoDefinição Técnica: 1. Autenticar o usuário cliente URI + /api/vversion/Autenticador/AutenticarUsuario; 2. Preencher os parâmetros de request para uso do endpoint. Definição de Negócio: 1. Consulta o Modelo de Comissão disponível para utilização em uma proposta de venda. Informação: 1. A propriedade 'Padrão' no retorno indica o modelo de comissão padrão utilizado pelo vendedor, no entanto, ela será retornada como True.data: {
. codigoEmpresa (integer)
. codigoObra (string)
. codigoVendedor (integer)
. dataVenda (string)
. qtdeParcelas (integer)
. listaUnidades (array)
} (object) required
post_api_v1_comissao_consultar_estrutura_comissaoDefinição Técnica: 1. Autenticar o usuário cliente URI + /api/vversion/Autenticador/AutenticarUsuario 2. Preencher os parâmetros de request para uso do endpoint. Definição de Negócio: 1. Consulta a estrutura de comissão do vendedor. 2. A propriedade SobreRecebimento está descontinuada, mas continuará retornando as informações nela conforme o preenchimento da nova propriedade, chamada RegraLiberacao. 3. A propriedade codigo da hierarquia se tornou obsoleta, precisamos apenas do número dadata: {
. empresa (integer)
. obra (string)
. codigoVendedor (integer)
. codigoHierarquia (integer)
. numeroComissao (integer)
. valorComissao (number)
. produtos (array)
} (object) required
post_api_v1_composicoes_inserir_composicoesDefinição Técnica: 1. Autenticar o usuário cliente URI + /api/vversion/Autenticador/AutenticarUsuario 2. Preencher os parâmetros de request para uso do método.data: {
. codigo (string)
. descricao (string)
. unidade (string)
. prodEquipe (number)
. tipoCusto (string)
. civilPes (integer)
. status (integer)
. categoria (string)
. categoriaMovFin (string)
. CAP (string)
. CAPEstorno (string)
. CAPTransacaoFinanceira (string)
. NCM (string)
. CEST (string)
. aplicacao (string)
. codigoServicoFiscal (string)
. controlaFVS (boolean)
. confirmado (integer)
. porcQtdeExcedidaEntrega (string)
. porcPrecoExcedidoEntrega (string)
. porcPrecoReduzidoEntrega (string)
} (object) required
post_api_v1_composicoes_atualizar_composicoesDefinição Técnica: 1. Autenticar o usuário cliente URI + /api/vversion/Autenticador/AutenticarUsuario 2. Preencher os parâmetros de request para uso do método. Utilize '' vazio caso queira limpar os campos do cadastro sendo que, código, descrição e unidade padrão, não podem ficar vazios.data: {
. listaComposicoesAtualizar (array)
} (object) required
post_api_v1_composicoes_consultar_todas_composicoesDefinição Técnica: 1. Autenticar o usuário cliente URI + /api/vversion/Autenticador/AutenticarUsuario 2. Preencher os parâmetros de request para uso do método.No parameters
post_api_v1_composicoes_consultar_composicoes_por_chaveDefinição Técnica: 1. Autenticar o usuário cliente URI + /api/vversion/Autenticador/AutenticarUsuario 2. Preencher os parâmetros de request para uso do método.data: {
. codigo (string)
. descricao (string)
. unidade (string)
. status (integer)
. prodEquipe (number)
. tipoCusto (string)
. civilPes (integer)
. categoria (string)
. categoriaMovFin (string)
. CAP (string)
. CAPEstorno (string)
. CAPTransacaoFinanceira (string)
. NCM (string)
. CEST (string)
. aplicacao (string)
. codigoServicoFiscal (string)
. controlaFVS (boolean)
. confirmado (integer)
. porcQtdeExcedidaEntrega (string)
. porcPrecoExcedidoEntrega (string)
. porcPrecoReduzidoEntrega (string)
} (object) required
post_api_v1_composicoes_consultar_insumos_da_composicaoDefinição Técnica: 1. Autenticar o usuário cliente URI + /api/vversion/Autenticador/AutenticarUsuario 2. Preencher os parâmetros de request para uso do método.data: {
. codigo (string)
. descricao (string)
. unidade (string)
. status (integer)
. prodEquipe (number)
. tipoCusto (string)
. civilPes (integer)
. categoria (string)
. categoriaMovFin (string)
. CAP (string)
. CAPEstorno (string)
. CAPTransacaoFinanceira (string)
. NCM (string)
. CEST (string)
. aplicacao (string)
. codigoServicoFiscal (string)
. controlaFVS (boolean)
. confirmado (integer)
. porcQtdeExcedidaEntrega (string)
. porcPrecoExcedidoEntrega (string)
. porcPrecoReduzidoEntrega (string)
} (object) required
post_api_v1_composicoes_alterar_insumo_composicoes_geralDefinição Técnica: 1. Autenticar o usuário cliente URI + /api/vversion/Autenticador/AutenticarUsuario 2. Preencher os parâmetros de request para uso do método.data: {
. codComposicao (string)
. codInsumo (string)
. tipoItem (integer)
. coeficiente (number)
. preco (number)
} (object) required
post_api_v1_composicoes_inserir_insumo_composicoes_geralDefinição Técnica: 1. Autenticar o usuário cliente URI + /api/vversion/Autenticador/AutenticarUsuario 2. Preencher os parâmetros de request para uso do método.data: {
. codComposicao (string)
. codInsumo (string)
. tipoItem (integer)
. coeficiente (number)
. preco (number)
} (object) required
post_api_v1_composicoes_consultar_composicoes_por_descricaoDefinição Técnica: 1. Autenticar o usuário cliente URI + /api/vversion/Autenticador/AutenticarUsuario 2. Preencher os parâmetros de request para uso do método.data: {
. descricao (string)
} (object) required
post_api_v1_composicoes_consultar_composicoes_com_filtro_livreDefinição Técnica: 1. Autenticar o usuário cliente URI + /api/vversion/Autenticador/AutenticarUsuario 2. Preencher os parâmetros de request para uso do método. Definição de negócio: Permite consultar os registros de composições gerais utilizando um filtro livre com qualquer um dos campos existentes Exemplo de filtro a ser utilizado: 1. 'filtro': 'Cod_comp = '10.50'' 2. 'filtro': 'Descr_comp LIKE 'TERRAPLANAGEM%'' 3. 'filtro': 'Cod_comp = '10.50' AND Descr_comp LIKE 'TERRAPLANAGEM%'data: {
. filtro (string)
} (object) required
post_api_v1_composicoes_alterar_insumo_composicoes_geral_pesadaDefinição Técnica: 1. Autenticar o usuário cliente URI + /api/vversion/Autenticador/AutenticarUsuario 2. Preencher os parâmetros de request para uso do método.data: {
. codComposicao (string)
. codInsumo (string)
. tipoItem (integer)
. coeficiente (number)
. preco (number)
. coefProd (number)
. coefImProd (number)
. dMT (number)
} (object) required
post_api_v1_composicoes_inserir_insumo_composicoes_geral_pesadaDefinição Técnica: 1. Autenticar o usuário cliente URI + /api/vversion/Autenticador/AutenticarUsuario 2. Preencher os parâmetros de request para uso do método.data: {
. codComposicao (string)
. codInsumo (string)
. tipoItem (integer)
. coeficiente (number)
. preco (number)
. coefProd (number)
. coefImProd (number)
. dMT (number)
} (object) required
post_api_v1_config_gerais_retornar_versao_bdDefinição Técnica: 1. Autenticar o usuário cliente URI + /api/vversion/Autenticador/AutenticarUsuario 2. Preencher os parâmetros de request para uso do método. Definição de Negócio: Retornar a versão do BD.No parameters
post_api_v1_config_gerais_retornar_versao_wsDefinição Técnica: 1. Autenticar o usuário cliente URI + /api/vversion/Autenticador/AutenticarUsuario 2. Preencher os parâmetros de request para uso do método. Definição de Negócio: Retornar a versão do WS Web Service.No parameters
post_api_v1_config_gerais_obter_configuracao_de_casas_decimaisDefinição Técnica: 1. Autenticar o usuário cliente URI + /api/vversion/Autenticador/AutenticarUsuario 2. Preencher os parâmetros de request para uso do método. Definição de Negócio: Retorna a configuração de quantidade de casas decimais do sistema.No parameters
post_api_v1_contabil_consultar_saldo_de_contasDefinição Técnica: 1. Autenticar o usuário cliente URI + /api/vversion/Autenticador/AutenticarUsuario 2. Consultar os saldo das contas conbaeis com a URI + /api/vversion/Contabil/SaldoDeContas 3. Preencher os parâmetros de request para uso do método. Definição de Negócio: Pode-se consultar o saldo das contas contábeis do UAU, podendo fazer filtros pela empresa, tipo, ano e mês, com isso é possível fazer a integração da parte de saldos contábeis com o UAU 1. Deve informar obrigatoriamendata: {
. Empresa (integer)
. MesAno (string)
. Tipo (string)
} (object) required
post_api_v1_contabil_consultar_contas_contabeisDefinição Técnica: 1. Autenticar o usuário cliente URI + /api/vversion/Autenticador/AutenticarUsuario 2. Consultar os dados das contas contábeis com a URI + /api/vversion/Contabil/ConsultarContasContabeis 3. Preencher os parâmetros de request para uso do método. Definição de Negócio: Consulta os dados de contas contábeis do UAU, podendo fazer filtros pela empresa, ano, conta ou descrição da conta, com o intuito de buscar informações de uma conta contábil. 1. Deve informar obrigatoriamendata: {
. Empresa (integer)
. Ano (integer)
. Conta (string)
. DescricaoConta (string)
. LimitarRetornoEm (integer)
} (object) required
post_api_v1_contrato_material_servico_consultar_itens_contratoDefinição Técnica: 1. Autenticar o usuário cliente URI + /api/vversion/Autenticador/AutenticarUsuario 2. Preencher os parâmetros de request para uso do endpoint. Definição de Negócio: 1. Consultar itens presentes em um contrato.data: {
. empresa (integer)
. contrato (integer)
} (object) required
post_api_v1_contrato_material_servico_consultar_contrato_por_chaveDefinição Técnica: 1. Autenticar o usuário cliente URI + /api/vversion/Autenticador/AutenticarUsuario 2. Preencher os parâmetros de request para uso do endpoint. 3. Retorna os dados do contrato. Definição de Negócio: 1. Consulta contrato filtrando pela chave. Link para Virtuau relacionado: https://ajuda.globaltec.com.br/virtuau/contrato-de-materiais-e-servicos/data: {
. empresa (integer)
. contrato (integer)
} (object) required
post_api_v1_contrato_material_servico_consultar_contrato_por_fornecedorDefinição Técnica: 1. Autenticar o usuário cliente URI + /api/vversion/Autenticador/AutenticarUsuario 2. Preencher os parâmetros de request para uso do endpoint. Definição de Negócio: 1. Consulta os contratos de um fornecedor. Link para Virtuau relacionado: https://ajuda.globaltec.com.br/virtuau/contrato-de-materiais-e-servicos/data: {
. fornecedor (integer)
} (object) required
post_api_v1_contrato_material_servico_consultar_contrato_por_servico_materialDefinição Técnica: 1. Autenticar o usuário cliente URI + /api/vversion/Autenticador/AutenticarUsuario 2. Preencher os parâmetros de request para uso do endpoint. Definição de Negócio: 1. Consulta contrato filtrando por: 1. Empresa; 2. Serviço ou material; Link para Virtuau relacionado: https://ajuda.globaltec.com.br/virtuau/contrato-de-materiais-e-servicos/data: {
. empresa (integer)
. servicoMaterial (string)
} (object) required
post_api_v1_contrato_material_servico_consultar_itens_vinculo_orcamento_servicoDefinição Técnica: 1. Autenticar o usuário cliente URI + /api/vversion/Autenticador/AutenticarUsuario 2. Preencher os parâmetros de request para uso do endpoint. 3. Retorna os dados dos itens de contratos vinculados a um determinado orçamento de serviço. Definição de Negócio: 1. Consultar os itens de contratos de material/serviço que estejam vinculados a um determinado orçamento de serviço. 2. Para retornar apenas os itens de contratos que estejam aprovados, o parâmetro 'somenteContratosdata: {
. empresa (integer)
. obra (string)
. item (string)
. servico (string)
. orcamento (integer)
. somenteContratosAprovados (boolean)
} (object) required
post_api_v1_contrato_material_servico_consultar_saldo_reajustado_por_item_contratoDefinição Técnica: 1. Autenticar o usuário cliente URI + /api/vversion/Autenticador/AutenticarUsuario 2. Preencher os parâmetros de request para uso do endpoint. Definição de Negócio: 1. Consultar valores aprovados e saldo reajustado de itens do contrato. 2. Consulta contrato filtrando por: 1. Empresa obrigatório 2. Obra; 3. Situacoes pode ser informado uma lista de situações: - 0 - Andamento - 1 - Paralisado - 2 - Cancelado - 3 - Concludata: {
. empresa (integer)
. obra (string)
. contratos (array)
. situacoes (array)
} (object) required
post_api_v1_contrato_material_servico_consultar_itens_vinculo_planejamento_servicoConsultar os itens do vinculo com o planejamento - SERVIÇOSdata: {
. empresa (integer)
. obra (string)
. item (string)
. servico (string)
. produto (integer)
. contrato (integer)
} (object) required
post_api_v1_contrato_material_servico_consultar_contratos_itens_vinculado_orcamentoDefinição Técnica: 1. Autenticar o usuário cliente URI + /api/vversion/Autenticador/AutenticarUsuario 2. Preencher os parâmetros de request para uso do endpoint. 3. Retorna os dados dos itens de contratos vinculados a um determinado orçamento de serviço. Definição de Negócio: 1. Consultar os contratos e itens de contratos de material/serviço que estejam vinculados a um determinado orçamento de serviço. 2. Para retornar apenas os itens de contratos que estejam aprovados, o parâmetro 'somedata: {
. empresa (integer)
. obra (string)
. orcamento (integer)
. somenteContratosAprovados (boolean)
} (object) required
post_api_contrato_material_servico_obter_lista_estrutura_aprovacoesNo description availableintNumAprov (string) required
tipoAprovacao (string) required
tipoPedido (string)
api-version (string)
gerAprov._listaEstruturaDeAprovacao (string)
gerAprov.codigoDaEmpresa (string)
gerAprov.codigoDaObra (string)
gerAprov.tipoDoProcesso (string)
gerAprov.quantidadeAprovacao (string)
gerAprov.valorSolicitado (string)
gerAprov.usuarioLogado (string)
gerAprov.acao (string)
gerAprov.estruturaAprovacao (string)
gerAprov.estruturaAprovFaixaValor (string)
gerAprov.codigoDepartamento (string)
gerAprov.codigoCargo (string)
gerAprov.listaSeqPendAprovAbaixoSeqUsuarioLog (string)
gerAprov.isAprovForaSequencia (string)
gerAprov.chaveJustificativaAprovacao (string)
repAprovSimulaConf.stringFormat (string)
repAprovSimulaConf.empresa_apSC (string)
repAprovSimulaConf.obra_apSC (string)
repAprovSimulaConf.numeroSim_apSC (string)
repAprovSimulaConf.numCot_apSC (string)
repAprovSimulaConf.usrAprov_apSC (string)
repAprovSimulaConf.dataAprov_apSC (string)
repAprovSimulaConf.codCargo_ApSC (string)
repAprovSimulaConf.codDep_ApSC (string)
repAprovSimulaConf.numJusAprov_apSC (string)
repAprovSimulaConf.num_apSC (string)
repAprovSimulaConf.s_Empresa_apSC (string)
repAprovSimulaConf.s_Obra_apSC (string)
repAprovSimulaConf.s_NumeroSim_apSC (string)
repAprovSimulaConf.s_NumCot_apSC (string)
repAprovSimulaConf.s_UsrAprov_apSC (string)
repAprovSimulaConf.s_DataAprov_apSC (string)
repAprovSimulaConf.s_CodCargo_ApSC (string)
repAprovSimulaConf.s_CodDep_ApSC (string)
repAprovSimulaConf.s_NumJusAprov_apSC (string)
repAprovSimulaConf.s_Num_apSC (string)
repAprovSimulaConf.querySource (string)
repAprovSimulaConf.mappingName (string)
repAprovSimulaConf.schemaGlobal (string)
repAprovSimulaConf.schemaTableView (string)
repAprovSimulaConf.schemaStoredProcedure (string)
repAprovSimulaConf.notRecommendedConnection.connectionString (string)
repAprovSimulaConf.notRecommendedConnection.commandTimeout (string)
repAprovSimulaConf.notRecommendedConnection.connectionTimeout (string)
repAprovSimulaConf.notRecommendedConnection.defaultDatabase (string)
repAprovSimulaConf.notRecommendedConnection.isolationLevel (string)
repAprovSimulaConf.notRecommendedConnection.attributes (string)
repAprovSimulaConf.notRecommendedConnection.cursorLocation (string)
repAprovSimulaConf.notRecommendedConnection.mode (string)
repAprovSimulaConf.notRecommendedConnection.provider (string)
repAprovSimulaConf.connectionString (string)
repAprovSimulaConf.connectionStringConfig (string)
repAprovSimulaConf.filter (string)
repAprovSimulaConf.sort (string)
repAprovCont.stringFormat (string)
repAprovCont.empresa_ApCont (string)
repAprovCont.codCont_ApCont (string)
repAprovCont.usrAprov_ApCont (string)
repAprovCont.dataAprov_ApCont (string)
repAprovCont.codCargo_ApCont (string)
repAprovCont.codDep_ApCont (string)
repAprovCont.numJusAprov_ApCont (string)
repAprovCont.num_ApCont (string)
repAprovCont.s_Empresa_ApCont (string)
repAprovCont.s_CodCont_ApCont (string)
repAprovCont.s_UsrAprov_ApCont (string)
repAprovCont.s_DataAprov_ApCont (string)
repAprovCont.s_CodCargo_ApCont (string)
repAprovCont.s_CodDep_ApCont (string)
repAprovCont.s_NumJusAprov_ApCont (string)
repAprovCont.s_Num_ApCont (string)
repAprovCont.querySource (string)
repAprovCont.mappingName (string)
repAprovCont.schemaGlobal (string)
repAprovCont.schemaTableView (string)
repAprovCont.schemaStoredProcedure (string)
repAprovCont.notRecommendedConnection.connectionString (string)
repAprovCont.notRecommendedConnection.commandTimeout (string)
repAprovCont.notRecommendedConnection.connectionTimeout (string)
repAprovCont.notRecommendedConnection.defaultDatabase (string)
repAprovCont.notRecommendedConnection.isolationLevel (string)
repAprovCont.notRecommendedConnection.attributes (string)
repAprovCont.notRecommendedConnection.cursorLocation (string)
repAprovCont.notRecommendedConnection.mode (string)
repAprovCont.notRecommendedConnection.provider (string)
repAprovCont.connectionString (string)
repAprovCont.connectionStringConfig (string)
repAprovCont.filter (string)
repAprovCont.sort (string)
repAprovMed.stringFormat (string)
repAprovMed.empresa_apmed (string)
repAprovMed.codCont_apmed (string)
repAprovMed.codMed_apmed (string)
repAprovMed.usrAprov_apmed (string)
repAprovMed.dataAprov_apmed (string)
repAprovMed.codCargo_apmed (string)
repAprovMed.codDep_apmed (string)
repAprovMed.numJusAprov_apmed (string)
repAprovMed.num_apmed (string)
repAprovMed.s_Empresa_apmed (string)
repAprovMed.s_CodCont_apmed (string)
repAprovMed.s_CodMed_apmed (string)
repAprovMed.s_UsrAprov_apmed (string)
repAprovMed.s_DataAprov_apmed (string)
repAprovMed.s_CodCargo_apmed (string)
repAprovMed.s_CodDep_apmed (string)
repAprovMed.s_NumJusAprov_apmed (string)
repAprovMed.s_Num_apmed (string)
repAprovMed.querySource (string)
repAprovMed.mappingName (string)
repAprovMed.schemaGlobal (string)
repAprovMed.schemaTableView (string)
repAprovMed.schemaStoredProcedure (string)
repAprovMed.notRecommendedConnection.connectionString (string)
repAprovMed.notRecommendedConnection.commandTimeout (string)
repAprovMed.notRecommendedConnection.connectionTimeout (string)
repAprovMed.notRecommendedConnection.defaultDatabase (string)
repAprovMed.notRecommendedConnection.isolationLevel (string)
repAprovMed.notRecommendedConnection.attributes (string)
repAprovMed.notRecommendedConnection.cursorLocation (string)
repAprovMed.notRecommendedConnection.mode (string)
repAprovMed.notRecommendedConnection.provider (string)
repAprovMed.connectionString (string)
repAprovMed.connectionStringConfig (string)
repAprovMed.filter (string)
repAprovMed.sort (string)
repAprovSimula.stringFormat (string)
repAprovSimula.empresa_apsim (string)
repAprovSimula.numSim_apsim (string)
repAprovSimula.numCot_apsim (string)
repAprovSimula.usrAprov_apsim (string)
repAprovSimula.dataAprov_apsim (string)
repAprovSimula.codCargo_apsim (string)
repAprovSimula.codDep_apsim (string)
repAprovSimula.numJusAprov_apsim (string)
repAprovSimula.num_apsim (string)
repAprovSimula.s_Empresa_apsim (string)
repAprovSimula.s_NumSim_apsim (string)
repAprovSimula.s_NumCot_apsim (string)
repAprovSimula.s_UsrAprov_apsim (string)
repAprovSimula.s_DataAprov_apsim (string)
repAprovSimula.s_CodCargo_apsim (string)
repAprovSimula.s_CodDep_apsim (string)
repAprovSimula.s_NumJusAprov_apsim (string)
repAprovSimula.s_Num_apsim (string)
repAprovSimula.querySource (string)
repAprovSimula.mappingName (string)
repAprovSimula.schemaGlobal (string)
repAprovSimula.schemaTableView (string)
repAprovSimula.schemaStoredProcedure (string)
repAprovSimula.notRecommendedConnection.connectionString (string)
repAprovSimula.notRecommendedConnection.commandTimeout (string)
repAprovSimula.notRecommendedConnection.connectionTimeout (string)
repAprovSimula.notRecommendedConnection.defaultDatabase (string)
repAprovSimula.notRecommendedConnection.isolationLevel (string)
repAprovSimula.notRecommendedConnection.attributes (string)
repAprovSimula.notRecommendedConnection.cursorLocation (string)
repAprovSimula.notRecommendedConnection.mode (string)
repAprovSimula.notRecommendedConnection.provider (string)
repAprovSimula.connectionString (string)
repAprovSimula.connectionStringConfig (string)
repAprovSimula.filter (string)
repAprovSimula.sort (string)
rsAprovRequisicaoCompra.sort (string)
repAprovacoesPL.stringFormat (string)
repAprovacoesPL.numSap_ApPlan (string)
repAprovacoesPL.usrAprov_ApPlan (string)
repAprovacoesPL.dataAprov_ApPlan (string)
repAprovacoesPL.codCargo_ApPlan (string)
repAprovacoesPL.codDep_ApPlan (string)
repAprovacoesPL.numJusAprov_ApPlan (string)
repAprovacoesPL.num_ApPlan (string)
repAprovacoesPL.s_NumSap_ApPlan (string)
repAprovacoesPL.s_UsrAprov_ApPlan (string)
repAprovacoesPL.s_DataAprov_ApPlan (string)
repAprovacoesPL.s_CodCargo_ApPlan (string)
repAprovacoesPL.s_CodDep_ApPlan (string)
repAprovacoesPL.s_NumJusAprov_ApPlan (string)
repAprovacoesPL.s_Num_ApPlan (string)
repAprovacoesPL.querySource (string)
repAprovacoesPL.mappingName (string)
repAprovacoesPL.schemaGlobal (string)
repAprovacoesPL.schemaTableView (string)
repAprovacoesPL.schemaStoredProcedure (string)
repAprovacoesPL.notRecommendedConnection.connectionString (string)
repAprovacoesPL.notRecommendedConnection.commandTimeout (string)
repAprovacoesPL.notRecommendedConnection.connectionTimeout (string)
repAprovacoesPL.notRecommendedConnection.defaultDatabase (string)
repAprovacoesPL.notRecommendedConnection.isolationLevel (string)
repAprovacoesPL.notRecommendedConnection.attributes (string)
repAprovacoesPL.notRecommendedConnection.cursorLocation (string)
repAprovacoesPL.notRecommendedConnection.mode (string)
repAprovacoesPL.notRecommendedConnection.provider (string)
repAprovacoesPL.connectionString (string)
repAprovacoesPL.connectionStringConfig (string)
repAprovacoesPL.filter (string)
repAprovacoesPL.sort (string)
repGerAprovacaoMat.stringFormat (string)
repGerAprovacaoMat.empresa_ApPedM (string)
repGerAprovacaoMat.obra_ApPedM (string)
repGerAprovacaoMat.insumo_ApPedM (string)
repGerAprovacaoMat.numPedido_ApPedM (string)
repGerAprovacaoMat.itemPed_ApPedM (string)
repGerAprovacaoMat.usrAprov_ApPedM (string)
repGerAprovacaoMat.dataAprov_ApPedM (string)
repGerAprovacaoMat.codCargo_ApPedM (string)
repGerAprovacaoMat.codDep_ApPedM (string)
repGerAprovacaoMat.numJusAprov_ApPedM (string)
repGerAprovacaoMat.num_ApPedM (string)
repGerAprovacaoMat.s_Empresa_ApPedM (string)
repGerAprovacaoMat.s_Obra_ApPedM (string)
repGerAprovacaoMat.s_Insumo_ApPedM (string)
repGerAprovacaoMat.s_NumPedido_ApPedM (string)
repGerAprovacaoMat.s_ItemPed_ApPedM (string)
repGerAprovacaoMat.s_UsrAprov_ApPedM (string)
repGerAprovacaoMat.s_DataAprov_ApPedM (string)
repGerAprovacaoMat.s_CodCargo_ApPedM (string)
repGerAprovacaoMat.s_CodDep_ApPedM (string)
repGerAprovacaoMat.s_NumJusAprov_ApPedM (string)
repGerAprovacaoMat.s_Num_ApPedM (string)
repGerAprovacaoMat.querySource (string)
repGerAprovacaoMat.mappingName (string)
repGerAprovacaoMat.schemaGlobal (string)
repGerAprovacaoMat.schemaTableView (string)
repGerAprovacaoMat.schemaStoredProcedure (string)
repGerAprovacaoMat.notRecommendedConnection.connectionString (string)
repGerAprovacaoMat.notRecommendedConnection.commandTimeout (string)
repGerAprovacaoMat.notRecommendedConnection.connectionTimeout (string)
repGerAprovacaoMat.notRecommendedConnection.defaultDatabase (string)
repGerAprovacaoMat.notRecommendedConnection.isolationLevel (string)
repGerAprovacaoMat.notRecommendedConnection.attributes (string)
repGerAprovacaoMat.notRecommendedConnection.cursorLocation (string)
repGerAprovacaoMat.notRecommendedConnection.mode (string)
repGerAprovacaoMat.notRecommendedConnection.provider (string)
repGerAprovacaoMat.connectionString (string)
repGerAprovacaoMat.connectionStringConfig (string)
repGerAprovacaoMat.filter (string)
repGerAprovacaoMat.sort (string)
repGerAprovacaoServ.stringFormat (string)
repGerAprovacaoServ.numPedido_ApPedS (string)
repGerAprovacaoServ.empresa_ApPedS (string)
repGerAprovacaoServ.obra_ApPedS (string)
repGerAprovacaoServ.serv_ApPedS (string)
repGerAprovacaoServ.usrAprov_ApPedS (string)
repGerAprovacaoServ.dataAprov_ApPedS (string)
repGerAprovacaoServ.codCargo_ApPedS (string)
repGerAprovacaoServ.codDep_ApPedS (string)
repGerAprovacaoServ.numJusAprov_ApPedS (string)
repGerAprovacaoServ.num_ApPedS (string)
repGerAprovacaoServ.s_NumPedido_ApPedS (string)
repGerAprovacaoServ.s_Empresa_ApPedS (string)
repGerAprovacaoServ.s_Obra_ApPedS (string)
repGerAprovacaoServ.s_Serv_ApPedS (string)
repGerAprovacaoServ.s_UsrAprov_ApPedS (string)
repGerAprovacaoServ.s_DataAprov_ApPedS (string)
repGerAprovacaoServ.s_CodCargo_ApPedS (string)
repGerAprovacaoServ.s_CodDep_ApPedS (string)
repGerAprovacaoServ.s_NumJusAprov_ApPedS (string)
repGerAprovacaoServ.s_Num_ApPedS (string)
repGerAprovacaoServ.querySource (string)
repGerAprovacaoServ.mappingName (string)
repGerAprovacaoServ.schemaGlobal (string)
repGerAprovacaoServ.schemaTableView (string)
repGerAprovacaoServ.schemaStoredProcedure (string)
repGerAprovacaoServ.notRecommendedConnection.connectionString (string)
repGerAprovacaoServ.notRecommendedConnection.commandTimeout (string)
repGerAprovacaoServ.notRecommendedConnection.connectionTimeout (string)
repGerAprovacaoServ.notRecommendedConnection.defaultDatabase (string)
repGerAprovacaoServ.notRecommendedConnection.isolationLevel (string)
repGerAprovacaoServ.notRecommendedConnection.attributes (string)
repGerAprovacaoServ.notRecommendedConnection.cursorLocation (string)
repGerAprovacaoServ.notRecommendedConnection.mode (string)
repGerAprovacaoServ.notRecommendedConnection.provider (string)
repGerAprovacaoServ.connectionString (string)
repGerAprovacaoServ.connectionStringConfig (string)
repGerAprovacaoServ.filter (string)
repGerAprovacaoServ.sort (string)
post_api_v1_correio_eletronico_enviar_mail_interno_uauDefinição Técnica: 1. Autenticar o usuário cliente URI + /api/vversion/Autenticador/AutenticarUsuario 2. Preencher os parâmetros de request para uso do endpoint Definição de Negócio: 1. Possibilita envio de email interno para o usuário root. 2. Valida as informaçõe passadas no request.data: {
. mensagem_envio (string)
. usuariosuau_destino (string)
. usuariouau_envio (string)
. assunto (string)
} (object) required
post_api_v1_cotacao_atualizar_item_cotacaoDefinição Técnica: 1. Autenticar o usuário cliente URI + /api/vversion/Cotacao/AtualizarItemCotacao 2. Preencher os parâmetros de request para uso do endpoint. Definição de Negócio: 1. Permite atualizar os dados dos itens de cotação, seja ela de material ou de serviço. 2. Para cotações específicas que forem pertencentes à cotação geral, serão alteradas somente a quantidade e a marca no caso de cotação de material. Os demais valores só serão alterados se a cotação geral for informadadata: {
. listaItensCotacao (array)
} (object) required
post_api_v1_cotacao_conta_cotacoes_aprov_mobDefinição Técnica: 1. Autenticar o usuário cliente URI + /api/vversion/Autenticador/ContaCotacoesMob 2. Preencher os parâmetros de request para uso do endpoint. Definição de Negócio: 1. Consultar a quantidade de cotações de material e serviço que possuem simulações que o usuário pode aprovar.data: {
. usuario (string)
} (object) required
post_api_v1_cotacao_aprovar_simulacoes_compraDefinição Técnica: 1. Autenticar o usuário cliente URI + /api/vversion/Autenticador/AutenticarUsuario 2. Preencher os parâmetros de request para uso do endpoint. Definição de Negócio: 1. É necessário permissão de aprovação para o programa ALSIMULCOTdata: {
. Simulacoes (array)
} (object) required
post_api_v1_cotacao_adicionar_fornecedor_cotacaoDefinição Técnica: 1. Autenticar o usuário cliente URI + /api/vversion/Cotacao/AdicionarFornecedorCotacao 2. Preencher os parâmetros de request para uso do endpoint. Definição de Negócio: 1. Permite vincular um fornecedor a uma cotação em aberto de material ou serviço. 2. Para identificação do fornecedor, são aceitos o código ou CPF/CNPJ deste no sistema. 3. Para vínculo do fornecedor a uma cotação específica, o código dessa cotação, empresa e, o CPF/CNPJ ou código do fornecedor devem sedata: {
. codFornecedor (integer)
. CNPJFornecedor (string)
. numeroCotacao (integer)
. numeroCotacaoGeral (integer)
. empresa (integer)
} (object) required
post_api_v1_cotacao_buscar_itens_cotacao_fornecedorDefinição Técnica: 1. Autenticar o usuário cliente URI + /api/vversion/Cotacao/BuscarItensCotacaoFornecedor 2. Preencher os parâmetros de request para uso do endpoint. Definição de Negócio: 1. Permite consultar os dados de itens de cotação de material ou serviço por código do fornecedor. 2. Somente cotações com status '0 - Criada' são retornadas.data: {
. empresa (integer)
. cotacao (integer)
. fornecedor (integer)
. origem (integer)
} (object) required
post_api_v1_cotacao_consultar_itens_cotacao_por_obraDefinição Técnica: 1. Autenticar o usuário cliente URI + /api/vversion/Autenticador/AutenticarUsuario 2. Preencher os parâmetros de request para uso do endpoint. Definição de Negócio: 1. Permite consultar itens da cotação de material ou serviço que esteja aguardando confirmação por obra, filtrando por empresa, obra e número da cotação.data: {
. empresa (integer)
. obra (string)
. cotacao (integer)
} (object) required
post_api_v1_cotacao_buscar_cotacao_aberta_fornecedorDefinição Técnica: 1. Autenticar o usuário cliente URI + /api/vversion/Autenticador/AutenticarUsuario 2. Preencher os parâmetros de request para uso do endpoint. Definição de Negócio: 1. Permite consultar os dados de cotações de material ou serviço que estão disponíveis para o fornecedor. Os tipos de cotações retornadas são: - 0 - Cot. material regular - 1 - Cot. material adiant. contrato - 2 - Cot. serviço regular - 3 - Cot. patrimônio - 4 - Cot. material contratodata: {
. cnpj (string)
} (object) required
post_api_v1_cotacao_aprovar_confirmacao_cotacao_por_obraDefinição Técnica: 1. Autenticar o usuário cliente URI + /api/vversion/Autenticador/AutenticarUsuario 2. Preencher os parâmetros de request para uso do endpoint. Definição de Negócio: 1. Possibilita aprovar a confirmação da cotação de material ou serviço por obra.data: {
. listaConfirmarAprovacaoCotacao (array)
} (object) required
post_api_v1_cotacao_remover_aprovacao_simulacoes_compraDefinição Técnica: 1. Autenticar o usuário cliente URI + /api/vversion/Autenticador/AutenticarUsuario 2. Preencher os parâmetros de request para uso do endpoint. Definição de Negócio: 1. É necessário permissão de exclusão para o programa ALCONFCOT caso a cotação esteja no fechamento de compra e permissão exclusão para o programa ALANALISE caso a cotação esteja na confirmação de cotação por obra.data: {
. Simulacoes (array)
} (object) required
post_api_v1_cotacao_atualizar_condicao_pagamento_entregaDefinição Técnica: 1. Autenticar o usuário cliente URI + /api/vversion/Cotacao/AtualizarCondicaoPagamentoEntrega 2. Preencher os parâmetros de request para uso do endpoint. Definição de Negócio: 1. Permite atualizar os dados de condição de entrega da cotação, bem como dias para entrega, quantidade de parcela, intervalo das parcelas, entre outros. 2. A condição de pagamento utilizada será sempre SOBRE A ENTREGA. 3. Para atualizar as condições de pagamento de uma cotação específica, o códidata: {
. empresa (integer)
. cotacao (integer)
. numeroCotacaoGeral (integer)
. fornecedor (integer)
. diasEntrega (integer)
. quantidadeEntrega (integer)
. intervaloEntrega (integer)
. diasPagamento (integer)
. quantidadeParcela (integer)
. intervaloParcela (integer)
. tipoFrete (integer)
. tipoPagamento (integer)
. CondicaoPagamento (string)
} (object) required
post_api_v1_cotacao_consultar_aprovacao_da_cotacao_por_obraDefinição Técnica: 1. Autenticar o usuário cliente URI + /api/vversion/Autenticador/AutenticarUsuario 2. Preencher os parâmetros de request para uso do endpoint. Definição de Negócio: 1. São consultadas as aprovações já realizadas para uma determinada cotação de material ou serviço.data: {
. codigoEmpresa (integer)
. codigoObra (string)
. numeroSimulacao (integer)
. numeroCotacao (integer)
} (object) required
post_api_v1_cotacao_reprovar_confirmacoes_cotacao_por_obraDefinição Técnica: 1. Autenticar o usuário cliente URI + /api/vversion/Autenticador/AutenticarUsuario 2. Preencher os parâmetros de request para uso do endpoint. Definição de Negócio: 1. É necessário permissão de exclusão para o programa ALCONFCOT caso a cotação esteja no fechamento de compra e permissão exclusão para o programa ALANALISE caso a cotação esteja na confirmação de cotação por obra.data: {
. ConfirmacoesCotacao (array)
. justificativaReprovacao (string)
} (object) required
post_api_cotacao_conta_cotacoes_mobConto as cotações que possuem simulações que o usuário pode aprovar.login_usuario (string) required
api-version (string)
post_api_v1_cotacao_consultar_cotacoes_confirmacao_pendenteDefinição Técnica: 1. Autenticar o usuário cliente URI + /api/vversion/Autenticador/AutenticarUsuario 2. Preencher os parâmetros de request para uso do endpoint. Definição de Negócio: 1. Consulta cotações de material e serviço que estão com as confirmações pendentes.data: {
. usuario (string)
. departamento (string)
. cargo (string)
. listaEmpObras (array)
. cotacao (integer)
} (object) required
post_api_v1_cotacao_consultar_quantidade_cotacao_pendente_por_obraDefinição Técnica: 1. Autenticar o usuário cliente URI + /api/vversion/Autenticador/AutenticarUsuario 2. Preencher os parâmetros de request para uso do endpoint. Definição de Negócio: 1. Verifica a quantidade de cotações de material e serviço com pendência na aprovação filtrando por obra.data: {
. loginUsuario (string)
. codigoDepartamento (string)
. codigoCargo (string)
. listaEmpObras (array)
} (object) required
post_api_v1_cotacao_consultar_quantidade_cotacao_pendente_por_obra_mobDefinição Técnica: 1. Autenticar o usuário cliente URI + /api/vversion/Autenticador/AutenticarUsuario 2. Preencher os parâmetros de request para uso do endpoint. Definição de Negócio: 1. Consultar a quantidade de cotações de material e serviço com pendência na aprovação filtrando por obra.data: {
. loginUsuario (string)
. codigoDepartamento (string)
. codigoCargo (string)
. listaEmpObras (array)
} (object) required
post_api_v1_cotacao_consultar_justificativas_aprovacao_fora_sequenciaDefinição Técnica: 1. Autenticar o usuário cliente URI + /api/vversion/Autenticador/AutenticarUsuario 2. Preencher os parâmetros de request para uso do endpoint. Definição de Negócio: 1. Consultar as justificativas que podem ser utilizadas em aprovações de confirmação de cotação de material ou serviço que esteja fora da sequência do usuário Controle de aprovações.No parameters
post_api_v1_cotacao_inserir_altera_coment_forn_freteDefinição Técnica: 1. Autenticar o usuário cliente URI + /api/vversion/Autenticador/InserirAlteraComentFornFrete 2. Preencher os parâmetros de request para uso do endpoint. Definição de Negócio: 1. Inserir um comentário ou atualizar um já existente.data: {
. empresa (integer)
. codigo_fornecedor (integer)
. cotacao (integer)
. cond_pagto (integer)
. tipo_coment (integer)
. efet_pgto_parc (integer)
. dtvenc_ini (string)
. qtde_parc (number)
. intev_parc (number)
. obs_pgto (string)
. obs_entrega (string)
. tipo_pgto (integer)
. tem_frete (integer)
. diaini_venc (integer)
. freteqtde_ent (integer)
. interv_ent (integer)
. diasEntrega (integer)
} (object) required
tipoCarenciaFixa (string)
get_api_v1_documentos_digitais_docu_sign_consentimentoNo description availablecode (string) required
get_api_v1_documentos_digitais_assine_on_line_config_templateNo description availableid (string) required
post_api_v1_documentos_digitais_docu_sign_envelope_statusNo description availableNo parameters
post_api_v1_documentos_digitais_enviar_envelope_de_documentoDefinição Técnica:br / Rota de envio de documentos digitais para assinatura atraves dos sistemas configurados. br / Sendo possivel utilizar Docusign ou Clicksign br / Passos: 1. Autenticar o usuário cliente URI + /api/vversion/Autenticador/AutenticarUsuario 2. Preencher os parâmetros de request para uso do método. Parametros: 1. ListaDePessoas - Nome_enva = and gt; Nome da pessoa - Ordem_enva = and gt; Ordem de assinatura Apenas para Docusign - Email_enva = and gt; Email ddata: {
. ListaDePessoas (array)
. ListaDeDocumentos (array)
. Mensagem (string)
. CodigoDoSistema (integer)
} (object) required
post_api_v1_documentos_digitais_consultar_documentos_enviadosDefinição Técnica:br / Rota de consulta de documentos enviados da Docusign atraves do numero de identificação do envelope 1. Autenticar o usuário cliente URI + /api/vversion/Autenticador/AutenticarUsuario 2. Preencher os parâmetros de request para uso do método. Parametros: - Codigo identificador do envelopedata: {
. NumeroDoEnvelope (integer)
} (object) required
post_api_v1_documentos_digitais_consultar_assinaturas_enviadasDefinição Técnica: br / Rota de consulta de assinaturas enviadas da Docusign atraves do numero de identificação do envelope br / Passos: 1. Autenticar o usuário cliente URI + /api/vversion/Autenticador/AutenticarUsuario 2. Preencher os parâmetros de request para uso do método. Parametros: - Codigo identificador do envelopedata: {
. NumeroDoEnvelope (integer)
} (object) required
post_api_v1_documentos_digitais_consulta_documentos_digitais_ativosDefinição Técnica: br / Rota de consulta de documentos digitais ativos e configurados no sistema. br / 1. Autenticar o usuário cliente URI + /api/vversion/Autenticador/AutenticarUsuario Retorno do metodo é o codigo e nome dos sistemas configurados para assinatura digitalNo parameters
post_api_v1_documentos_digitais_consultar_envelope_documentos_codigo_externoDefinição Técnica: br / Rota de consulta de envelopes da Docusign apenas pelo codigo externo do evelope. br / O código externo é o código identificador do envelope na Docusign br / Passos: 1. Autenticar o usuário cliente URI + /api/vversion/Autenticador/AutenticarUsuario 2. Preencher os parâmetros de request para uso do método. Parametros: - Codigo externo do envelopedata: {
. EnvelopeId (string)
} (object) required
post_api_v1_empresa_consultar_empresaDefinição Técnica: 1. Autenticar o usuário cliente URI + /api/vversion/Autenticador/AutenticarUsuario 2. Preencher os parâmetros de request para uso do método.data: {
. codigoEmpresa (integer)
} (object) required
post_api_v1_empresa_obter_empresas_ativasDefinição Técnica: 1. Autenticar o usuário cliente URI + /api/vversion/Autenticador/AutenticarUsuario 2. Preencher os parâmetros de request para uso do método.No parameters
post_api_v1_empresa_consultar_dados_basicos_empresas_por_filtroDefinição Técnica: 1. Autenticar o usuário cliente URI + /api/vversion/Autenticador/AutenticarUsuario 2. Consultar os dados do usuário logado para obter o código do cliente URI + /api/vversion/Empresa/DadosBasicosEmpresa 3. Preencher os parâmetros de request para uso do método. Definição de Negócio: Consultar dados de empresas por meio dos seguintes filtros empresa, cnpj e descricaoEmpresa, os resultados da busca será de acordo com o limite especificado no parâmetro limitarRetornoEm. 2.data: {
. Empresa (integer)
. DescricaoEmpresa (string)
. Cnpj (string)
. LimitarRetornoEm (integer)
} (object) required
post_api_v1_espelho_alterar_status_unidadeDefinição Técnica: 1. Autenticar o usuário cliente URI + /api/vversion/Autenticador/AutenticarUsuario 2. Preencher os parâmetros de request para uso do método.data: {
. codigoEmpresa (integer)
. codigoProduto (integer)
. numeroPersonalizacao (integer)
. novoStatusUnidade (integer)
. motivoAlteracao (string)
. categoriaStatusPersonalizacao (integer)
} (object) required
post_api_v1_espelho_consultar_espelhos_vendaDefinição Técnica: 1. Autenticar o usuário cliente URI + /api/vversion/Autenticador/AutenticarUsuario 2. Preencher os parâmetros de request para uso do método.data: {
. usuario_logado (string)
} (object) required
post_api_v1_espelho_retornar_menor_preco_personDefinição Técnica: 1. Autenticar o usuário cliente URI + /api/vversion/Autenticador/AutenticarUsuario 2. Preencher os parâmetros de request para uso do método.data: {
. tipoContrato (integer)
. codProduto (integer)
. codCategPreco (string)
. numeroPerson (integer)
. empresa (integer)
. dataCategPrecoProduto (string)
. porcPrecoMinimo (number)
} (object) required
post_api_v1_espelho_atualizar_campos_customizadosDefinição Técnica: 1. Autenticar o usuário cliente URI + /api/vversion/Autenticador/AutenticarUsuario 2. Preencher os parâmetros de request para uso do método.data: {
. campos_custom (object)
} (object) required
post_api_v1_espelho_consultar_unidade_per_por_chaveDefinição Técnica: 1. Autenticar o usuário cliente URI + /api/vversion/Autenticador/AutenticarUsuario 2. Preencher os parâmetros de request para uso do método.data: {
. codigoEmpresa (integer)
. codigoProduto (integer)
. numeroPersonalizacao (integer)
} (object) required
post_api_v1_espelho_busca_unidades_de_acordo_com_whereDefinição Técnica: 1. Autenticar o usuário cliente URI + /api/vversion/Autenticador/AutenticarUsuario 2. Preencher os parâmetros de request para uso do método.data: {
. where (string)
. retorna_venda (boolean)
} (object) required
post_api_v1_espelho_alterar_data_entrega_chaves_unidadeDefinição Técnica: 1. Autenticar o usuário cliente URI + /api/vversion/Autenticador/AutenticarUsuario 2. Preencher os parâmetros de request para uso do método.data: {
. codigoEmpresa (integer)
. codigoProduto (integer)
. numeroPersonalizacao (integer)
. dataEntregaChaves (string)
. observacao (string)
} (object) required
post_api_v1_espelho_consultar_personalizacoes_com_precosDefinição Técnica: 1. Autenticar o usuário cliente URI + /api/vversion/Autenticador/AutenticarUsuario 2. Preencher os parâmetros de request para uso do método.data: {
. usuario (string)
. empresa (integer)
. num_produto (integer)
. cod_obra (string)
. num_personalizacao (integer)
. consultarapenasnao_vendidos (boolean)
. tipo_contrato (integer)
. datatabela_preco (string)
. campos_person (string)
. status_person (string)
. num_espelho (integer)
. tipocontrato_grafico (integer)
} (object) required
post_api_v1_espelho_busca_unidades_de_acordo_com_where_detalhado- parâmetros de request da classe BuscaUnidadesDeAcordoComWhereDetalhadoRequestdata: {
. where (string)
. retorna_venda (boolean)
. data_tabela_preco (string)
} (object) required
post_api_v1_estrutura_excluir_estruturaDefinição técnica: 1. Autenticar o usuário cliente URI + /api/vversion/Autenticador/AutenticarUsuario 2. Preencher os parâmetros de request para uso do método. Definição de negócio: Permite excluir uma estrutura completa caso o valor do parâmetro sequência seja 0 - raiz ou apenas um item da estruturaCaso o tipo do item seja '0 - Nível', também serão excluídos os itens filhos. Link para Virtuau relacionado: https://ajuda.globaltec.com.br/virtuau/estruturasdata: {
. codigoEstrutura (integer)
. sequencia (string)
} (object) required
post_api_v1_estrutura_inserir_estruturaDefinição técnica: 1. Autenticar o usuário cliente URI + /api/vversion/Autenticador/AutenticarUsuario 2. Preencher os parâmetros de request para uso do método. Definição de negócio: Permite inserir uma estrutura. Após inserir, poderá vincular os itens da estrutura. Link para Virtuau relacionado: https://ajuda.globaltec.com.br/virtuau/estruturasdata: {
. descricao (string)
} (object) required
post_api_v1_estrutura_excluir_item_de_estruturaDefinição técnica: 1. Autenticar o usuário cliente URI + /api/vversion/Autenticador/AutenticarUsuario 2. Preencher os parâmetros de request para uso do método. Definição de negócio: Permite excluir um item de estrutura que não está sendo utilizado no cadastro de estrutura, orçamento, contrato ou serviços do planejamento . Link para Virtuau relacionado: https://ajuda.globaltec.com.br/virtuau/estruturasdata: {
. codigoItem (string)
} (object) required
post_api_v1_estrutura_inserir_item_de_estruturaDefinição técnica: 1. Autenticar o usuário cliente URI + /api/vversion/Autenticador/AutenticarUsuario 2. Preencher os parâmetros de request para uso do método. Definição de negócio: Permite inserir um item de estrutura. Após inserir, poderá se utilizado no cadastro de estrutura e ser vinculado em orçamento, contrato e serviços do planejamento. Link para Virtuau relacionado: https://ajuda.globaltec.com.br/virtuau/estruturasdata: {
. codigoItem (string)
. descricaoItem (string)
} (object) required
post_api_v1_estrutura_inserir_item_na_estruturaDefinição técnica: 1. Autenticar o usuário cliente URI + /api/vversion/Autenticador/AutenticarUsuario 2. Preencher os parâmetros de request para uso do método. Definição de negócio: Permite inserir item em uma estrutura. Após concluir o cadastro da estrutura, poderá ser vinculada em orçamento, contrato e serviços do planejamento. Link para Virtuau relacionado: https://ajuda.globaltec.com.br/virtuau/estruturasdata: {
. codigoEstrutura (integer)
. tipoEstrutura (integer)
. sequencia (string)
. codigoItem (string)
} (object) required
post_api_v1_eventos_consultar_log_eventosDefinição Técnica: 1. Autenticar o usuário cliente URI + /api/vversion/Autenticador/AutenticarUsuario 3. Preencher os parâmetros de request para uso do método. 4. Os campos do tipo data devem obedecer o formato especificado pelo JSON. 1. yyyy-MM-dd HH:mm:ss and gt; 2019-01-22 00:00:00 2. yyyy-MM-dd and gt; 2018-12-25 Definição de Negócio: Permite consultar logs de eventos. 1. Verifique as chaves de consultas disponíveis no endpoint: - URI + /api/vversion/Eventos/Consultadata: {
. Chave (string)
. DataInicial (string)
. DataFinal (string)
} (object) required
post_api_v1_eventos_consultar_chaves_log_de_eventosDefinição Técnica: 1. Autenticar o usuário cliente URI + /api/vversion/Autenticador/AutenticarUsuario Regras de Negócio: 1. A chave de acesso consultada informa quais chaves poderão ser utilizadas no seguinte endpoint: 1. URI + /api/vversion/Eventos/ConsultarLogEventos Anexos: 1. Postman: https://ajuda.globaltec.com.br/download/777172/No parameters
post_api_v1_extrato_do_cliente_gerar_pdfextrato_clienteDefinição Técnica: 1. Autenticar o usuário cliente URI + /api/vversion/Autenticador/AutenticarUsuario 2. Preencher os parâmetros de request para uso do método. 3. Preencher as opções de visualização do extrato nos módulos Vendas/Shopping, menu Utilitários, submenu Configurações extrato da venda Visão Cliente Obs.: Parâmetros para impressão deste extrato são configurados na tela descrita neste virtuau: https://ajuda.globaltec.com.br/virtuau/configuracao-extrato-de-vendas-visao-clientedata: {
. empresa (integer)
. obra (string)
. numVenda (integer)
. tipoOrdenacao (integer)
. valorAntecipado (boolean)
. dataProrrogacao (boolean)
. ocultarPersonalizacao (boolean)
. ocultarUsuario (boolean)
. dataCalculo (string)
. residuoIraComporValorTotal (boolean)
} (object) required
post_api_v1_extrato_do_cliente_gerar_pdfextrato_cliente_v2Definição Técnica: 1. Autenticar o usuário cliente URI + /api/vversion/Autenticador/AutenticarUsuario 2. Preencher os parâmetros de request para uso do método. 3. Preencher as opções de visualização do extrato nos módulos Vendas/Shopping, menu Utilitários, submenu Configurações extrato da venda Visão Cliente Obs.: Parâmetros para impressão deste extrato são configurados na tela descrita neste virtuau: https://ajuda.globaltec.com.br/virtuau/configuracao-extrato-de-vendas-visao-clientedata: {
. empresa (integer)
. obra (string)
. numVenda (integer)
. tipoOrdenacao (integer)
. valorAntecipado (boolean)
. dataProrrogacao (boolean)
. ocultarPersonalizacao (boolean)
. ocultarUsuario (boolean)
. dataCalculo (string)
. residuoIraComporValorTotal (boolean)
} (object) required
post_api_v1_extrato_do_cliente_consultar_saldo_cessoes_direito_anterioresRetorna o somatório do saldo já pago das vendas anteriores de cessão de direitodata: {
. empresa (integer)
. obra (string)
. num_venda (integer)
} (object) required
post_api_v1_extrato_do_cliente_consultar_dados_demonstrativo_pagto_clienteRetorna informações das parcelas pagas, informações do cliente e unidades/produtos de uma determinada venda.data: {
. empresa (integer)
. obra (string)
. num_venda (integer)
. tipos_parc (string)
. tipo_ordenacao (integer)
. mostrara_pagas (boolean)
. princ_juros (boolean)
. descontopor_adiantamento (boolean)
. valor_antecipado (boolean)
. nome_fantasia (boolean)
. ocultapref_custas (boolean)
. dataCalculo (string)
. exibirDataDeposito (boolean)
} (object) required
post_api_v1_fiscal_buscar_capsDefinição Técnica: 1. Autenticar o usuário cliente URI + /api/vversion/Autenticador/AutenticarUsuario 2. Preencher os parâmetros de request para uso do endpoint. 3. Formato dos dados retornados: - Codigo String: Código do CAP - Descricao String: Descrição do CAP - Tipo Integer: Tipo do CAP - 0: Geral - 1: Acresc/DescNo parameters
post_api_v1_fiscal_buscar_codigo_servico_fiscalDefinição Técnica: 1. Autenticar o usuário cliente URI + /api/vversion/Autenticador/AutenticarUsuario 2. Preencher os parâmetros de request para uso do endpoint. Definição de Negócio: 1. Consulta os códigos de serviços fiscais ativos.No parameters
post_api_v1_fiscal_importar_lancamentos_fiscaisDefinição Técnica: 1. Autenticar o usuário cliente URI + /api/vversion/Autenticador/AutenticarUsuario 2. Preencher os parâmetros de request para uso do endpoint. 3. Recebe string no formato XML com os dados do lançamento para importação. 4. Utiliza o formato antigo do XML na string passada como parâmetro. Definição de Negócio: 1. Importa lançamentos fiscais e/ou societários. 2. Valida o XML passado no request. 3. Valida o usuário e suas permissões.data: {
. dadoslacamentos_xml (string)
} (object) required
post_api_v1_fiscal_importar_lancamentos_contabeisDefinição Técnica: 1. Autenticar o usuário cliente URI + /api/vversion/Autenticador/AutenticarUsuario 2. Preencher os parâmetros de request para uso do endpoint. 3. Utiliza o novo formato do XML na string passada como parâmetro. Definição de Negócio: 1. Importa lançamentos fiscais e/ou societários. 2. Valida o XML passado no request. 3. Valida usuário e suas permissões.data: {
. dadoslacamentos_xml (string)
} (object) required
post_api_v1_folha_gravar_alocacao_mao_obraDefinição Técnica: 1. Autenticar o usuário cliente URI + /api/vversion/Autenticador/AutenticarUsuario 2. Preencher os parâmetros de request para uso do método GravarAlocacaoMaoObra. Definição de Negócio: 1. Efetua a inclusão ou alteraçãocaso o registro já exista na alocação de mão de obra para funcionários do UAU. 2. Deve informar obrigatoriamente os campos: - Código da empresa de lotação do funcionário - Matrícula do funcionário - Mês de referência do cálculo da folha do funciondata: {
. ListaAlocacao (array)
} (object) required
post_api_v1_folha_gravar_movimentacao_mensal_obraDefinição Técnica: 1. Autenticar o usuário cliente URI + /api/vversion/Autenticador/AutenticarUsuario 2. Preencher os parâmetros de request para uso do método GravarMovimentacaoMensalObra. Definição de Negócio: 1. Efetua a inclusão ou alteraçãocaso o registro já exista na movimentação mensal por obra dos funcionários do UAU. 2. Deve informar obrigatoriamente os campos: - Código da empresa de lotação do funcionário - Matrícula do funcionário - Código da rubrica a ser rateada na emdata: {
. ListaMovimentacaoObra (array)
} (object) required
post_api_v1_funcionario_consultar_funcionarioDefinição Técnica: 1. Autenticar o usuário cliente URI + /api/vversion/Autenticador/AutenticarUsuario 2. Consultar os dados dos funcionários URI + api/vversion:apiVersion/Funcionario/ConsultarFuncionario 3. Preencher os parâmetros de request para uso do método. Definição de Negócio: Consulta os dados de funcionários do UAU, podendo fazer filtros pela empresa, obra, pessoa, funcionário, matrícula e situação. 1. Deve informar obrigatoriamente o código da empresa. 2. Pode informar opcionaldata: {
. CodigoEmpresa (integer)
. CodigoObra (string)
. CodigoPessoa (integer)
. CodigoFuncionario (integer)
. Matricula (string)
. Situacao (integer)
} (object) required
post_api_v1_insumos_geral_inserir_insumos_geralDefinição Técnica: 1. Autenticar o usuário cliente URI + /api/vversion/Autenticador/AutenticarUsuario 2. Preencher os parâmetros de request para uso do método.data: {
. codigo (string)
. descricao (string)
. unidade (string)
. unidadesInsumo (array)
. usuario (string)
. status (integer)
. confirmado (integer)
. controlarPrecoMeta (boolean)
. diasDeCompra (integer)
. diasUtilizacao (integer)
. numeroDeCompras (integer)
. diasEntrega (integer)
. numeroPagamentos (integer)
. tipoPagamento (integer)
. controle (integer)
. controlaEstoque (integer)
. pagamentoSobre (integer)
. preco (string)
. dataCotacao (string)
. frequenciaCompra (string)
. comoPagar (string)
. CAP (string)
. categoriaMovFin (string)
. CAPAplicacaoMaterial (string)
. CAPEstorno (string)
. CAPTransacaoFinanceira (string)
. CategoriaDoInsumo (string)
. NCM (string)
. CEST (string)
. Aplicacao (string)
. grupo (integer)
. calcEncargo (integer)
. controlaFVM (boolean)
. patrimonio (integer)
. depreciacao (string)
. grupoDeInsumos (string)
. rateioParaMecanicos (number)
. indicadorUtilBem (integer)
. capacidadeDiariaTrabalho (string)
. marcaModelo (string)
. subgrupo (integer)
. itemManutencao (boolean)
} (object) required
post_api_v1_insumos_geral_atualizar_insumos_geralDefinição Técnica: 1. Autenticar o usuário cliente URI + /api/vversion/Autenticador/AutenticarUsuario 2. Preencher os parâmetros de request para uso do método. Definição de negócio: Permite realizar manutenção em massa no cadastro dos insumos gerais. Utilize '' caso queira limpar os campos do cadastro sendo que, código, descrição e unidade padrão, não podem ficar vazios. Link para Virtuau relacionado: https://ajuda.globaltec.com.br/virtuau/parametrizacao-de-insumos-gerais/data: {
. listaInsumosAtualizar (array)
} (object) required
post_api_v1_insumos_geral_consultar_insumos_geralDefinição Técnica: 1. Autenticar o usuário cliente URI + /api/vversion/Autenticador/AutenticarUsuario 2. Preencher os parâmetros de request para uso do método. 3. Nenhum parâmetro é obrigatório e os dados são retornados utilizando o LIKE para encontrar as informações.data: {
. codigo_insumo (string)
. descricao_insumo (string)
. codigosub_grupo (integer)
. item_manutencao (integer)
. patrimonio (integer)
} (object) required
post_api_v1_insumos_geral_consultar_insumos_geral_por_chaveDefinição Técnica: 1. Autenticar o usuário cliente URI + /api/vversion/Autenticador/AutenticarUsuario 2. Preencher os parâmetros de request para uso do método.data: {
. codigo (string)
. descricao (string)
. unidade (string)
. unidadesInsumo (array)
. usuario (string)
. status (integer)
. confirmado (integer)
. controlarPrecoMeta (boolean)
. diasDeCompra (integer)
. diasUtilizacao (integer)
. numeroDeCompras (integer)
. diasEntrega (integer)
. numeroPagamentos (integer)
. tipoPagamento (integer)
. controle (integer)
. controlaEstoque (integer)
. pagamentoSobre (integer)
. preco (string)
. dataCotacao (string)
. frequenciaCompra (string)
. comoPagar (string)
. CAP (string)
. categoriaMovFin (string)
. CAPAplicacaoMaterial (string)
. CAPEstorno (string)
. CAPTransacaoFinanceira (string)
. CategoriaDoInsumo (string)
. NCM (string)
. CEST (string)
. Aplicacao (string)
. grupo (integer)
. calcEncargo (integer)
. controlaFVM (boolean)
. patrimonio (integer)
. depreciacao (string)
. grupoDeInsumos (string)
. rateioParaMecanicos (number)
. indicadorUtilBem (integer)
. capacidadeDiariaTrabalho (string)
. marcaModelo (string)
. subgrupo (integer)
. itemManutencao (boolean)
} (object) required
post_api_v1_insumos_geral_consultar_insumos_geral_por_descricaoDefinição Técnica: 1. Autenticar o usuário cliente URI + /api/vversion/Autenticador/AutenticarUsuario 2. Preencher os parâmetros de request para uso do método.data: {
. Descricao (string)
} (object) required
post_api_v1_lista_preco_referencia_inserir_fornecedoresDefinição Técnica: 1. Autenticar o usuário cliente URI + /api/vversion/Autenticador/AutenticarUsuario 2. Preencher os parâmetros de request para uso do método. Regras Básicas: 1. O usuário deve possuir permissão de inclusao no programa 'ALLISTAPRECOREF' 2. Para incluir um fornecedor, a lista já deve existir no sistema. 3. A lista deve estar em aberto, não pode ter nenhuma confirmação de aprovação.data: {
. NumeroLista (integer)
. CodigoFornecedor (integer)
. CPFCNPJ (string)
. ValorMinimoPedFOB (number)
. ValorMinimoPedCIF (number)
. DataInicio (string)
. DataTermino (string)
. Contato (string)
. ItensPorFornecedor (array)
} (object) required
post_api_v1_lista_preco_referencia_atualizar_item_fornecedorDefinição Técnica: 1. Autenticar o usuário cliente URI + /api/vversion/Autenticador/AutenticarUsuario 2. Preencher os parâmetros de request para uso do método. Regras Básicas: 1. O usuário deve possuir permissão de alteração no programa 'ALLISTAPRECOREF' 2. Para atualizar um fornecedor, a lista já deve existir no sistema e o fornecedor já deve estar cadastro. 3. A lista deve estar em aberto, não pode ter nenhuma confirmação de aprovação.data: {
. NumeroLista (integer)
. CodigoFornecedor (integer)
. CPFCNPJ (string)
. ValorMinimoPedFOB (number)
. ValorMinimoPedCIF (number)
. DataInicio (string)
. DataTermino (string)
. Contato (string)
. ItensPorFornecedor (array)
} (object) required
post_api_v1_lista_preco_referencia_consultar_lista_preco_referenciaDefinição Técnica: 1. Autenticar o usuário cliente URI + /api/vversion/Autenticador/AutenticarUsuario 2. Preencher os parâmetros de request para uso do método. Regras Básicas: 1. Pelo menos um parâmetro deve ser preenchido para consulta. 2. Parâmetros: - CodigoLista: Parâmetro principal, caso seja informado irá sobrepor todos os outros. - FornecedorCodigo: Fará a pesquisa pelo código do fornecedor, caso não possua o CNPJ. - FornecedorCNPJ: Fará a pesquisa pelo CNPJ do fornecedodata: {
. NumeroLista (integer)
. DataValidade (string)
. Status (integer)
. FornecedorCNPJ (string)
. FornecedorCodigo (integer)
} (object) required
post_api_v1_localidade_consultar_localidade_por_cepDefinição Técnica: 1. Autenticar o usuário cliente URI + /api/vversion/Autenticador/AutenticarUsuario 2. Preencher os parâmetros de request para uso do método. Definição de Negócio: Consultar as informações da localidade informando apenas o CEP. 1. Valida a presença do CEP; 2. Retorna uma ou mais localidades para o CEP informado; 3. Retorna somente endereços ativos.data: {
. Cep (string)
} (object) required
post_api_v1_medicao_manter_medicaoDefinição Técnica: 1. Autenticar o usuário cliente URI + /api/vversion/Autenticador/AutenticarUsuario 2. Preencher os parâmetros de request para uso do método. Regras básicas: 1. É possível inserir ou atualizar uma medição de contrato de material e/ou serviço. 1.2. Se o número da medição for informado e essa medição existir, então ela será atualzada, caso contrário será inserida. 2. Só poderão ser atualizadas as medições que estiverem em aberto, ou seja, sem nenhuma confirmação de aprovadata: {
. Empresa (integer)
. NumeroContrato (integer)
. NumeroMedicao (integer)
. CodigoFornecedor (integer)
. CNPJFornecedor (string)
. NumCidadePrestacaoServ (integer)
. Observacao (string)
. UltimaMedicao (integer)
. DataBase (string)
. UsrCadastro (string)
. DescontosMedicao (array)
. Itens (array)
. Adiantamentos (array)
} (object) required
post_api_v1_medicao_excluir_medicaoDefinição Técnica: 1. Autenticar o usuário cliente URI + /api/vversion/Autenticador/AutenticarUsuario 2. Preencher os parâmetros de request para uso do método. Regras básicas: 1. Somente medições que estiverem abertas e sem nenhuma aprovação poderão ser excluídas. 2. Nenhum processo de pagamento poderá estar vinculado à medição. 3. Nâo pode haver vínculos dependentes entre os itens da medição vínculo de item do tipo material com item de serviço. 4. Não pode excluir medição que contenhadata: {
. Empresa (integer)
. Contrato (integer)
. NumeroMedicao (integer)
} (object) required
post_api_v1_medicao_consultar_medicaoDefinição Técnica: 1. Autenticar o usuário cliente URI + /api/vversion/Autenticador/AutenticarUsuario 2. Preencher os parâmetros de request para uso do método.data: {
. empresa (integer)
. contrato (integer)
. medicao (integer)
} (object) required
post_api_v1_medicao_consultar_itens_medicaoDefinição Técnica: 1. Autenticar o usuário cliente URI + /api/vversion/Autenticador/AutenticarUsuario 2. Preencher os parâmetros de request para uso do método. Definição de Negócio: 1. Retorna uma lista de itens da medição por empresa, contrato e medição.data: {
. empresa (integer)
. contrato (integer)
. medicao (integer)
} (object) required
post_api_v1_medicao_aprovar_medicao_contratoDefinição Técnica: 1. Autenticar o usuário cliente URI + /api/vversion/Autenticador/AutenticarUsuario 2. Preencher os parâmetros de request para uso do método. Regras básicas: 1. O contrato precisa estar com status aprovado. 2. É necessário permissão de aprovação para o programa OBMEDCONTdata: {
. empresa (integer)
. contrato (integer)
. medicao (integer)
. Codigojustificativa (integer)
. Observacaojustificativa (string)
. departamento (string)
. cargo (string)
} (object) required
post_api_v1_medicao_consultar_boletim_medicaoDefinição Técnica: 1. Autenticar o usuário cliente URI + /api/vversion/Autenticador/AutenticarUsuario 2. Preencher os parâmetros de request para uso do método. Definição de Negócio: 1. Consulta boletim de medição dentro do sistema UAU.data: {
. empresa (integer)
. contrato (integer)
. avancoFisico (boolean)
. medicao (integer)
} (object) required
post_api_v1_medicao_consultar_medicao_completaDefinição Técnica: 1. Autenticar o usuário cliente URI + /api/vversion/Autenticador/AutenticarUsuario 2. Preencher os parâmetros de request para uso do método. Para retornar as medições, podem ser feitas as seguintes combinações: 1. Código da empresa e código do contrato 2. Código da empresa, código do contrato e código da medição 3. Código da empresa e CNPJ do contrato ou CNPJ do fornecedor informado na medição 4. Código da empresa e período de geração da medição data idata: {
. Empresa (integer)
. Contrato (integer)
. Medicao (integer)
. CNPJContratado (string)
. CNPJFornecedor (string)
. DataInicial (string)
. DataFinal (string)
} (object) required
post_api_v1_medicao_consultar_medicao_por_serv_matDefinição Técnica: 1. Autenticar o usuário cliente URI + /api/vversion/Autenticador/AutenticarUsuario 2. Preencher os parâmetros de request para uso do método.data: {
. empresa (integer)
. servMat (string)
} (object) required
post_api_v1_medicao_consultar_medicoes_por_statusDefinição Técnica: 1. Autenticar o usuário cliente URI + /api/vversion/Autenticador/AutenticarUsuario 2. Preencher os parâmetros de request para uso do método. Definição de Negócio: 1. Retorna uma lista de medições por status e usuário. 2. Os possíveis status de uma medição são: 0 - Aberta; 1 - Aprovada; 2 - Medida; 3 - Proc. Serviço Gerado. 3. O usuário é para indicar quais são as obras que ele possui permissão para retornar as medições pertinentes.data: {
. status_med (integer)
. login_usu (string)
} (object) required
post_api_medicao_validar_cnpjao_gravar_medicaoNo description availableCNPJ (string) required
data: {

} (object) required
api-version (string)
post_api_v1_medicao_consultar_medicao_por_contratoDefinição Técnica: 1. Autenticar o usuário cliente URI + /api/vversion/Autenticador/AutenticarUsuario 2. Preencher os parâmetros de request para uso do método.data: {
. empresa (integer)
. contrato (integer)
} (object) required
post_api_v1_medicao_consultar_itens_medicao_por_medicaoDefinição Técnica: 1. Autenticar o usuário cliente URI + /api/vversion/Autenticador/AutenticarUsuario 2. Preencher os parâmetros de request para uso do método.data: {
. empresa (integer)
. contrato (integer)
. medicao (integer)
} (object) required
post_api_v1_medicao_consultar_itens_medicao_por_serv_matDefinição Técnica: 1. Autenticar o usuário cliente URI + /api/vversion/Autenticador/AutenticarUsuario 2. Preencher os parâmetros de request para uso do método.data: {
. empresa (integer)
. servMat (string)
} (object) required
post_api_v1_medicao_consultar_itens_medicao_por_contratoDefinição Técnica: 1. Autenticar o usuário cliente URI + /api/vversion/Autenticador/AutenticarUsuario 2. Preencher os parâmetros de request para uso do método.data: {
. empresa (integer)
. contrato (integer)
} (object) required
post_api_v1_medicao_consultar_itens_medicao_por_item_contratoDefinição Técnica: 1. Autenticar o usuário cliente URI + /api/vversion/Autenticador/AutenticarUsuario 2. Preencher os parâmetros de request para uso do método.data: {
. empresa (integer)
. contrato (integer)
. medicao (integer)
. itemContrato (integer)
} (object) required
post_api_v1_modelo_venda_buscar_plano_indexadorDefinição Técnica: 1. Autenticar o usuário cliente URI + /api/vversion/Autenticador/AutenticarUsuario 2. Preencher os parâmetros de request para uso do método. Definição de Negócio: 1. Consulta o plano indexador vinculado ao modelo da venda.data: {
. nummodelo_venda (integer)
} (object) required
post_api_v1_modelo_venda_consultar_modelo_vendaDefinição Técnica: 1. Autenticar o usuário cliente URI + /api/vversion/Autenticador/AutenticarUsuario 2. Preencher os parâmetros de request para uso do método. Definição de Negócio: 1. Consulta o modelo de vendo filtrando pelo código do modelo. Tipos de Caps: Tipo Parcelamento: 0 - Contrato 1. 0 - Principal 2. 1 - Corr. por atraso 3. 2 - Juros contratual 4. 3 - Correçãodata: {
. codModeloVenda (integer)
} (object) required
post_api_v1_modelo_venda_gerar_parcelas_propostaDefinição Técnica: 1. Autenticar o usuário cliente URI + /api/vversion/Autenticador/AutenticarUsuario 2. Preencher os parâmetros de request para uso do método. Definição de Negócio: 1. Gera parcelas da proposta baseado nos parametros de parcelas informado. 2. Valida os campos passados na request.data: {
. parametromodelovenda (array)
. codigoEmpresa (integer)
. codigoObra (string)
. redistribuirValor (boolean)
. utilizarCap (boolean)
. tipoVenda (integer)
} (object) required
post_api_v1_modelo_venda_consultar_modelo_de_vendaDefinição Técnica: 1. Autenticar o usuário cliente URI + /api/vversion/Autenticador/AutenticarUsuario 2. Preencher os parâmetros de request para uso do método. Definição de Negócio: 1. Consulta o modelo da venda filtrando os parâmetros informados na request.data: {
. obra (string)
. empresa (integer)
. nummodelo_venda (integer)
. eat_inat (integer)
. campos_retornados (string)
. tipo (integer)
} (object) required
post_api_v1_modelo_venda_montar_modelo_renegociacaoDefinição Técnica: 1. Autenticar o usuário cliente URI + /api/vversion/Autenticador/AutenticarUsuario 2. Preencher os parâmetros de request para uso do método. Definição de Negócio: Permite gerar parâmetros do modelo e as parcelas para uma renegociação. 1. Somente usuários autenticados podem ter acesso a essa rota. 2. As informações recebidas no request devem existirem no UAU. 3. O modelo de venda deve estar aprovado para ser utilizado. 4. O modelo de venda informada está vinculado adata: {
. codModeloVenda (integer)
. empresa (integer)
. obra (string)
. numVenda (integer)
. ValorRenegContrato (number)
. ValorRenegCustas (number)
. ValorRenegSeguroMIP (number)
. ValorRenegSeguroDFI (number)
} (object) required
post_api_v1_modelo_venda_consultar_parcelas_modelo_vendaDefinição Técnica: 1. Autenticar o usuário cliente URI + /api/vversion/Autenticador/AutenticarUsuario 2. Preencher os parâmetros de request para uso do método. Definição de Negócio: 1. Consultar todos os tipo de parcelas do modelo de venda filtrando pela chave/número do modelo.data: {
. nummodelo_venda (integer)
} (object) required
post_api_v1_modelo_venda_consultar_modelo_de_venda_seguro_por_chaveDefinição Técnica: 1. Autenticar o usuário cliente URI + /api/vversion/Autenticador/AutenticarUsuario 2. Preencher os parâmetros de request para uso do método. Definição de Negócio: 1. Consulta o mo seguro do modelo de venda filtrando pela chave/número do modelo.data: {
. nummodelo_venda (integer)
} (object) required
post_api_v1_notas_fiscais_consultar_nfentradaDefinição Técnica: 1. Autenticar o usuário cliente URI + /api/vversion/Autenticador/AutenticarUsuario. 2. Preencher os parâmetros de request para uso do endpoint. Definição de Negócio: 1. Ao menos uma chave de pesquisa deve ser preenchida sendo elas CodigoEmpresa, CnpjFornecedor, CodigoFornecedor, DataInicial, ListaNFEntrada. 2. Caso tenha informado a propriedade da Obra, a Empresa torna-se obrigatória. 3. Preenchimento da DataInicial torna DataFinal obrigatória. 4. Preenchimento da Ddata: {
. ListaNFEntrada (array)
. CodigoEmpresa (integer)
. CodigoObra (string)
. CnpjFornecedor (string)
. CodigoFornecedor (string)
. DataInicial (string)
. DataFinal (string)
. TipoPeriodo (integer)
} (object) required
post_api_v1_notas_fiscais_salvar_arquivo_xmlnotafiscal_entradaDefinição Técnica: 1. Autenticar o usuário cliente URI + /api/vversion/Autenticador/AutenticarUsuario. 2. Preencher os parâmetros de request para uso do endpoint. Definição de Negócio: 1. Poderá ser enviado uma lista de arquivos XML. 2. Será permitido no máximo uma lista com 20 arquivos. 3. Tipo do arquivo XML TipoXML 0 para NF-e 1 para CT-e 2 para NFS-e, 4. Arquivo XML da nota fiscal Texto do arquivo ArquivoXML.data (array) required
post_api_v1_obras_obter_obras_ativasDefinição Técnica: 1. Autenticar o usuário cliente URI + /api/vversion/Autenticador/AutenticarUsuario 2. Preencher os parâmetros de request para uso do método. Definição de Negócio: 1. Consulta obras cadastradas e ativas dentro do UAU.No parameters
post_api_v1_obras_consultar_obra_por_chaveDefinição Técnica: 1. Autenticar o usuário cliente URI + /api/vversion/Autenticador/AutenticarUsuario 2. Preencher os parâmetros de request para uso do método. Definição de Negócio: 1. Consulta dados de uma obra filtrando por chave. 2. Valida os campos passados como parâmetros.data: {
. empresa (integer)
. obra (string)
} (object) required
post_api_v1_obras_obter_meses_abertos_por_empresa_obraNo description availabledata: {
. empresaObra (string)
} (object) required
post_api_v1_orcamento_alterar_insumo_orcamentoDefinição Técnica: 1. Autenticar o usuário cliente URI + /api/vversion/Autenticador/AutenticarUsuario 2. Preencher os parâmetros de request para uso do método.data: {
. empresa (integer)
. obra (string)
. orcamento (integer)
. composicao (string)
. insumo (string)
. usuario (string)
. quantidade (number)
. preco (number)
. tipoInsumo (integer)
. encargo (integer)
} (object) required
post_api_v1_orcamento_excluir_insumo_orcamentoDefinição Técnica: 1. Autenticar o usuário cliente URI + /api/vversion/Autenticador/AutenticarUsuario 2. Preencher os parâmetros de request para uso do método.data: {
. empresa (integer)
. obra (string)
. orcamento (integer)
. composicao (string)
. insumo (string)
. usuario (string)
. quantidade (number)
. preco (number)
. tipoInsumo (integer)
. encargo (integer)
} (object) required
post_api_v1_orcamento_inserir_insumo_orcamentoDefinição Técnica: 1. Autenticar o usuário cliente URI + /api/vversion/Autenticador/AutenticarUsuario 2. Preencher os parâmetros de request para uso do método.data: {
. InsumosOrcamento (array)
} (object) required
post_api_v1_orcamento_alterar_servico_orcamentoDefinição Técnica: 1. Autenticar o usuário cliente URI + /api/vversion/Autenticador/AutenticarUsuario 2. Preencher os parâmetros de request para uso do método.data: {
. usuario (string)
. quantidade (number)
. dataInicio (string)
. dataFim (string)
. empresa (integer)
. obra (string)
. numOrcamento (integer)
. item (string)
. servico (string)
. codExternoIntegracao (string)
} (object) required
post_api_v1_orcamento_excluir_servico_orcamentoDefinição Técnica: 1. Autenticar o usuário cliente URI + /api/vversion/Autenticador/AutenticarUsuario 2. Preencher os parâmetros de request para uso do método.data: {
. usuario (string)
. empresa (integer)
. obra (string)
. numOrcamento (integer)
. item (string)
. servico (string)
. codExternoIntegracao (string)
} (object) required
post_api_v1_orcamento_inserir_servico_orcamentoDefinição Técnica: 1. Autenticar o usuário cliente URI + /api/vversion/Autenticador/AutenticarUsuario 2. Preencher os parâmetros de request para uso do método.data: {
. ServicosOrcamento (array)
} (object) required
post_api_v1_orcamento_consultar_insumos_por_chaveDefinição Técnica: 1. Autenticar o usuário cliente URI + /api/vversion/Autenticador/AutenticarUsuario 2. Preencher os parâmetros de request para uso do método.data: {
. empresa (integer)
. obra (string)
. orcamento (integer)
. composicao (string)
} (object) required
post_api_v1_orcamento_alterar_planilha_cronogramaDefinição Técnica: 1. Autenticar o usuário cliente URI + /api/vversion/Autenticador/AutenticarUsuario 2. Preencher os parâmetros de request para uso do método.data: {
. usuario (string)
. empresa (integer)
. obra (string)
. numOrcamento (integer)
. item (string)
. servico (string)
. periodo (string)
. quantidade (number)
} (object) required
post_api_v1_orcamento_excluir_planilha_cronogramaDefinição Técnica: 1. Autenticar o usuário cliente URI + /api/vversion/Autenticador/AutenticarUsuario 2. Preencher os parâmetros de request para uso do método.data: {
. usuario (string)
. empresa (integer)
. obra (string)
. numOrcamento (integer)
. item (string)
. servico (string)
. periodo (string)
. quantidade (number)
} (object) required
post_api_v1_orcamento_inserir_planilha_cronogramaDefinição Técnica: 1. Autenticar o usuário cliente URI + /api/vversion/Autenticador/AutenticarUsuario 2. Preencher os parâmetros de request para uso do método.data: {
. usuario (string)
. empresa (integer)
. obra (string)
. numOrcamento (integer)
. item (string)
. servico (string)
. periodo (string)
. quantidade (number)
} (object) required
post_api_v1_orcamento_exportar_orcamento_estruturaDefinição Técnica: 1. Autenticar o usuário cliente URI + /api/vversion/Autenticador/AutenticarUsuario 2. Preencher os parâmetros de request para uso do método.data: {
. empresa (integer)
. obra (string)
. orcamento (integer)
} (object) required
post_api_v1_orcamento_consultar_estrutura_orca_por_chaveDefinição Técnica: 1. Autenticar o usuário cliente URI + /api/vversion/Autenticador/AutenticarUsuario 2. Preencher os parâmetros de request para uso do método.data: {
. sequencia (string)
. empresa (integer)
. obra (string)
. numOrcamento (integer)
. item (string)
. servico (string)
. codExternoIntegracao (string)
} (object) required
post_api_v1_orcamento_consultar_estrutura_orca_por_servicoDefinição Técnica: 1. Autenticar o usuário cliente URI + /api/vversion/Autenticador/AutenticarUsuario 2. Preencher os parâmetros de request para uso do método.data: {
. empresa (integer)
. obra (string)
. numOrcamento (integer)
. item (string)
. servico (string)
. codExternoIntegracao (string)
} (object) required
post_api_v1_orcamento_consultar_servico_orcamento_por_chaveDefinição Técnica: 1. Autenticar o usuário cliente URI + /api/vversion/Autenticador/AutenticarUsuario 2. Preencher os parâmetros de request para uso do método.data: {
. empresa (integer)
. obra (string)
. numOrcamento (integer)
. item (string)
. servico (string)
. codExternoIntegracao (string)
} (object) required
post_api_v1_orcamento_consultar_servico_orcado_desintegradoDefinição Técnica: 1. Autenticar o usuário cliente URI + /api/vversion/Autenticador/AutenticarUsuario 2. Preencher os parâmetros de request para uso do método.data: {
. empresa (integer)
. obra (string)
. numOrcamento (integer)
} (object) required
post_api_v1_orcamento_excluir_estrutura_servico_de_orcamentoDefinição Técnica: 1. Autenticar o usuário cliente URI + /api/vversion/Autenticador/AutenticarUsuario 2. Preencher os parâmetros de request para uso do método. Definição de Negócio: Permite excluir níveis ou itens de estruturas do serviço do orçamento. 1. Deve preencher os parâmetros de acordo com a estrutura que deseja excluir. 1.1 Informar se é nível ou item que esta excluindo, a sequencia e os dados do orçamento e serviço. 2. Valida se a estrutura poderá ser excluída. 3. Valida cdata: {
. EstruturasDeServicoDeOrcamento (array)
} (object) required
post_api_v1_orcamento_exportar_orcamento_estrutura_paginadaDefinição Técnica: 1. Autenticar o usuário cliente URI + /api/vversion/Autenticador/AutenticarUsuario 2. Preencher os parâmetros de request para uso do método.data: {
. empresa (integer)
. obra (string)
. orcamento (integer)
. Page (integer)
. PageSize (integer)
} (object) required
post_api_v1_orcamento_inserir_estrutura_servico_de_orcamentoDefinição Técnica: 1. Autenticar o usuário cliente URI + /api/vversion/Autenticador/AutenticarUsuario 2. Preencher os parâmetros de request para uso do método. Definição de Negócio: Permite inserir níveis ou itens de estruturas no serviço existente no orçamento. 1. Deve preencher os parâmetros de acordo com a estrutura que deseja inserir. 1.1 Informar se é nível ou item que esta inserindo, a sequencia e os dados do orçamento e serviço. 2. Valida se a estrutura poderá ser inserida. 3data: {
. EstruturasDeServicoDeOrcamento (array)
} (object) required
post_api_v1_orcamento_consultar_planilha_cronograma_por_chaveDefinição Técnica: 1. Autenticar o usuário cliente URI + /api/vversion/Autenticador/AutenticarUsuario 2. Preencher os parâmetros de request para uso do método.data: {
. usuario (string)
. empresa (integer)
. obra (string)
. numOrcamento (integer)
. item (string)
. servico (string)
. periodo (string)
} (object) required
post_api_v1_orcamento_atualizar_estrutura_servico_de_orcamentoDefinição Técnica: 1. Autenticar o usuário cliente URI + /api/vversion/Autenticador/AutenticarUsuario 2. Preencher os parâmetros de request para uso do método. Definição de Negócio: Permite alterar níveis ou itens de uma estrutura do serviço existente no orçamento 1. Deve preencher os parâmetros de acordo com a estrutura que deseja alterar . 1.1 Informar se é nível ou item que esta inserindo, a sequencia e os dados do orçamento e serviço. 2. Valida se a estrutura poderá ser alterada.data: {
. EstruturasDeServicoDeOrcamento (array)
} (object) required
post_api_v1_orcamento_consultar_servico_orcamento_por_orcamentoDefinição Técnica: 1. Autenticar o usuário cliente URI + /api/vversion/Autenticador/AutenticarUsuario 2. Preencher os parâmetros de request para uso do método.data: {
. empresa (integer)
. obra (string)
. numOrcamento (integer)
. tipoItem (integer)
} (object) required
post_api_pedido_compra_grava_pedido_de_compraNo description availabledata (object) required
tipo (string) required
api-version (string)
post_api_v1_pedido_compra_aprovar_pedido_compra_servico_appDefinição Técnica: 1. Autenticar o usuário cliente URI + /api/vversion/Autenticador/AutenticarUsuario 2. Preencher os parâmetros de request para uso do endpoint. Definição de Negócio: 1. Aprovar um item do pedido do tipo serviço. 2. Valida as entradas dos pedidos de compras.data: {
. codigo_empresa (integer)
. codigo_obra (string)
. servico (string)
. num_pedido (integer)
. mensagem_retorno (string)
. departamento (string)
. cargo (string)
. cod_justificativa (integer)
. obs_justificativa (string)
} (object) required
post_api_v1_pedido_compra_aprovar_pedido_compra_material_appDefinição Técnica: 1. Autenticar o usuário cliente URI + /api/vversion/Autenticador/AutenticarUsuario 2. Preencher os parâmetros de request para uso do endpoint. Definição de Negócio: 1. Aprovar um item do pedido de material realizado. 2. Valida as entradas dos pedidos de compras.data: {
. codigo_empresa (integer)
. codigo_obra (string)
. insumo (string)
. item_ped (integer)
. num_pedido (integer)
. mensagem_retorno (string)
. departamento (string)
. cargo (string)
. cod_justificativa (integer)
. obs_justificativa (string)
} (object) required
post_api_v1_pedido_compra_gravar_pedido_de_compra_do_tipo_servicoDefinição Técnica: 1. Autenticar o usuário cliente URI + /api/vversion/Autenticador/AutenticarUsuario 2. Preencher os parâmetros de request para uso do endpoint. 3. Retorna uma lista de string com os dados do pedido gerado ou uma mensagem de alerta caso não seja gerado corretamente. - Posição 0 = Numero do pedido; - Posição 1 = mensagem de erro Caso o pedido não seja gerado corretamente; Definição de Negócio: 1. Gerar um novo pedido de compra do tipo Serviço 2. 2. Valida as entdata: {
. dadosPedido (object)
. listaDadosItemPedido (array)
} (object) required
post_api_v1_pedido_compra_gravar_pedido_de_compra_do_tipo_materialDefinição Técnica: 1. Autenticar o usuário cliente URI + /api/vversion/Autenticador/AutenticarUsuario 2. Preencher os parâmetros de request para uso do endpoint. 3. Retorna uma lista de string com os dados do pedido gerado ou uma mensagem de alerta caso o pedido não seja gerado corretamente. - Posição 0 = Numero do pedido; - Posição 1 = mensagem de erro Caso o pedido não seja gerado corretamente; Definição de Negócio: 1. Gerar um novo pedido de compra do tipo material 0. 2. Valdata: {
. dadosPedido (object)
. listaDadosItemPedido (array)
} (object) required
post_api_v1_pedido_compra_gravar_pedido_de_compra_do_tipo_patrimonioDefinição Técnica: 1. Autenticar o usuário cliente URI + /api/vversion/Autenticador/AutenticarUsuario 2. Preencher os parâmetros de request para uso do endpoint. 3. Retorna uma lista de string com os dados do pedido gerado ou uma mensagem de alerta caso não seja gerado corretamente. - Posição 0 = Numero do pedido; - Posição 1 = mensagem de erro Caso o pedido não seja gerado corretamente; Definição de Negócio: 1. Gerar um novo pedido de compra do tipo Patrimônio 3. 2. Valida asdata: {
. dadosPedido (object)
. listaDadosItemPedido (array)
} (object) required
post_api_v1_pedido_compra_gravar_pedido_de_compra_do_tipo_complementoDefinição Técnica: 1. Autenticar o usuário cliente URI + /api/vversion/Autenticador/AutenticarUsuario 2. Preencher os parâmetros de request para uso do endpoint. 3. Retorna uma lista de string com os dados do pedido gerado ou uma mensagem de alerta caso o pedido não seja gerado corretamente. - Posição 0 = Numero do pedido; - Posição 1 = mensagem de erro Caso o pedido não seja gerado corretamente; Definição de Negócio: 1. Gerar um novo pedido de compra do tipo complemento 10. 2.data: {
. dadosPedido (object)
. listaDadosItemPedido (array)
} (object) required
post_api_v1_pedido_compra_gravar_pedido_de_compra_do_tipo_emergencialDefinição Técnica: 1. Autenticar o usuário cliente URI + /api/vversion/Autenticador/AutenticarUsuario 2. Preencher os parâmetros de request para uso do endpoint. 3. Retorna uma lista de string com os dados do pedido gerado ou uma mensagem de alerta caso não seja gerado corretamente. - Posição 0 = Numero do pedido; - Posição 1 = mensagem de erro Caso o pedido não seja gerado corretamente; Definição de Negócio: 1. Gerar um novo pedido de compra do tipo emergêncial 6. 2. Valida asdata: {
. dadosPedido (object)
. listaDadosItemPedido (array)
} (object) required
post_api_v1_pedido_compra_gravar_pedido_de_compra_do_tipo_adiantamentoDefinição Técnica: 1. Autenticar o usuário cliente URI + /api/vversion/Autenticador/AutenticarUsuario 2. Preencher os parâmetros de request para uso do endpoint. 3. Retorna uma lista de string com os dados do pedido gerado ou uma mensagem de alerta caso não seja gerado corretamente. - Posição 0 = Numero do pedido; - Posição 1 = mensagem de erro Caso o pedido não seja gerado corretamente; Definição de Negócio: 1. Gerar um novo pedido de compra do tipo adiantamento 1. 2. Valida adata: {
. dadosPedido (object)
. listaDadosItemPedido (array)
. numeroContrato (integer)
} (object) required
post_api_v1_pedido_compra_gravar_pedido_de_compra_do_tipo_regularizacaoDefinição Técnica: 1. Autenticar o usuário cliente URI + /api/vversion/Autenticador/AutenticarUsuario 2. Preencher os parâmetros de request para uso do endpoint. 3. Retorna uma lista de string com os dados do pedido gerado ou uma mensagem de alerta caso o pedido não seja gerado corretamente. - Posição 0 = Numero do pedido; - Posição 1 = mensagem de erro Caso o pedido não seja gerado corretamente; Definição de Negócio: 1. Gerar um novo pedido de compra do tipo regularização 9. 2data: {
. dadosPedido (object)
. listaDadosItemPedido (array)
} (object) required
post_api_v1_pedido_compra_confirmar_recebimento_ordem_compra_fornecedorDefinição Técnica: 1. Autenticar o usuário cliente URI + /api/vversion/Autenticador/AutenticarUsuario 2. Preencher os parâmetros de request para uso do método. Regras Básicas:data: {
. nomeFornecedor (string)
. codigoEmpresa (integer)
. codigoObra (string)
. ordemDeCompra (integer)
. tipoResposta (integer)
. observacao (string)
} (object) required
post_api_v1_pedido_compra_gravar_pedido_de_compra_do_tipo_servico_contratoDefinição Técnica: 1. Autenticar o usuário cliente URI + /api/vversion/Autenticador/AutenticarUsuario 2. Preencher os parâmetros de request para uso do endpoint. 3. Retorna uma lista de string com os dados do pedido gerado ou uma mensagem de alerta caso não seja gerado corretamente. - Posição 0 = Numero do pedido; - Posição 1 = mensagem de erro Caso o pedido não seja gerado corretamente; Definição de Negócio: 1. Gerar um novo pedido de compra do tipo 16 - Serviço contrato. 2. Vdata: {
. dadosPedido (object)
. listaDadosItemPedido (array)
} (object) required
post_api_v1_pedido_compra_gravar_pedido_de_compra_do_tipo_contrato_materialDefinição Técnica: 1. Autenticar o usuário cliente URI + /api/vversion/Autenticador/AutenticarUsuario 2. Preencher os parâmetros de request para uso do endpoint. 3. Retorna uma lista de string com os dados do pedido gerado ou uma mensagem de alerta caso não seja gerado corretamente. - Posição 0 = Numero do pedido; - Posição 1 = mensagem de erro Caso o pedido não seja gerado corretamente; Definição de Negócio: 1. Gerar um novo pedido de compra do tipo Contrato de material 4. 2.data: {
. dadosPedido (object)
. listaDadosItemPedido (array)
} (object) required
post_api_v1_pedido_compra_gravar_pedido_de_compra_do_tipo_servico_complementoDefinição Técnica: 1. Autenticar o usuário cliente URI + /api/vversion/Autenticador/AutenticarUsuario 2. Preencher os parâmetros de request para uso do endpoint. 3. Retorna uma lista de string com os dados do pedido gerado ou uma mensagem de alerta caso não seja gerado corretamente. - Posição 0 = Numero do pedido; - Posição 1 = mensagem de erro Caso o pedido não seja gerado corretamente; Definição de Negócio: 1. Gerar um novo pedido de compra do tipo 13 - Serviço complemento. 2data: {
. dadosPedido (object)
. listaDadosItemPedido (array)
} (object) required
post_api_v1_pedido_compra_gravar_pedido_de_compra_do_tipo_servico_emergencialDefinição Técnica: 1. Autenticar o usuário cliente URI + /api/vversion/Autenticador/AutenticarUsuario 2. Preencher os parâmetros de request para uso do endpoint. 3. Retorna uma lista de string com os dados do pedido gerado ou uma mensagem de alerta caso não seja gerado corretamente. - Posição 0 = Numero do pedido; - Posição 1 = mensagem de erro Caso o pedido não seja gerado corretamente; Definição de Negócio: 1. Gerar um novo pedido de compra do tipo 11 - Serviço emergencial. 2data: {
. dadosPedido (object)
. listaDadosItemPedido (array)
} (object) required
post_api_v1_pedido_compra_gravar_pedido_de_compra_do_tipo_servico_adiantamentoDefinição Técnica: 1. Autenticar o usuário cliente URI + /api/vversion/Autenticador/AutenticarUsuario 2. Preencher os parâmetros de request para uso do endpoint. 3. Retorna uma lista de string com os dados do pedido gerado ou uma mensagem de alerta caso não seja gerado corretamente. - Posição 0 = Numero do pedido; - Posição 1 = mensagem de erro Caso o pedido não seja gerado corretamente; Definição de Negócio: 1. Gerar um novo pedido de compra do tipo 15 - Serviço adiantamento dedata: {
. dadosPedido (object)
. listaDadosItemPedido (array)
. numeroContrato (integer)
} (object) required
post_api_v1_pedido_compra_gravar_pedido_de_compra_do_tipo_servico_regularizacaoDefinição Técnica: 1. Autenticar o usuário cliente URI + /api/vversion/Autenticador/AutenticarUsuario 2. Preencher os parâmetros de request para uso do endpoint. 3. Retorna uma lista de string com os dados do pedido gerado ou uma mensagem de alerta caso não seja gerado corretamente. - Posição 0 = Numero do pedido; - Posição 1 = mensagem de erro Caso o pedido não seja gerado corretamente; Definição de Negócio: 1. Gerar um novo pedido de compra do tipo 12 - Serviço regularização.data: {
. dadosPedido (object)
. listaDadosItemPedido (array)
} (object) required
post_api_pedido_compra_validar_permissao_assistente_pedido_servicoNo description availabledata (object) required
tipoPedido (string) required
api-version (string)
post_api_v1_pessoas_gravar_pessoaDefinição Técnica: 1. Autenticar o usuário cliente URI + /api/vversion/Autenticador/AutenticarUsuario 2. Preencher os parâmetros de request para uso do método. Definição de Negócio: Permite inserir ou alterar pessoa física ou jurídica e seus respectivos dados. Se for uma nova pessoa, informar '0' no parâmetro cod_pes. Se for alterar uma pessoa já existente, informar o código no parâmetro cod_pes. 1. Deve montar uma estrutura com as informações de determinada pessoa. - https://ajuda.globdata: {
. nao_validar_campos_obrigatorios (boolean)
. info_pes (object)
. info_pesfis (object)
. infopes_jur (object)
. dspes_tel_json (string)
. infopes_doc (object)
. info_pesendereco_principal (object)
. infopesendereco_cobranca
. infopesendereco_comercial
} (object) required
post_api_v1_pessoas_manter_telefoneDefinição Técnica: 1. Autenticar o usuário cliente URI + /api/vversion/Autenticador/AutenticarUsuario 2. Preencher os parâmetros de request para uso do método. 3. Número de usuário é obrigatório. 4. Nível de permissão, GETELPES Alteração ou Inclusão Definição de Negócio: 1. Quando o telefone não existe, ele é adicionado em relacionamento ao usuário proposto. 2. Quando o telefone já existe, ele faz a alteração dos dados. 3. Não se pode ter telefones iguais para a mesma pessoa. Caso tentdata: {
. Numero (integer)
. Telefones (array)
} (object) required
post_api_v1_pessoas_excluir_telefoneDefinição Técnica: 1. Autenticar o usuário cliente URI + /api/vversion/Autenticador/AutenticarUsuario 2. Preencher os parâmetros de request para uso do método. 3. Número de usuário é obrigatório. 4. Nível de permissão, GETELPES Exclusão Definição de Negócio: 1. A exclusão do telefone é feita somente para o usuário informado. Informação: 1. Cuidado ao alterar, compartilhar e/ou distribuir informações pessoais do cliente, fornecedor, funcionário e/ou prospect, considere avaliar se o prdata: {
. Numero (integer)
. Telefones (array)
} (object) required
post_api_v1_pessoas_consultar_unidadesDefinição Técnica: 1. Autenticar o usuário cliente URI + /api/vversion/Autenticador/AutenticarUsuario 2. Informar o código da pessoa ou CPF/CNPJ da pessoa para uso do método. Regras de Negócio: 1. CPF/CNPJ aceita apenas números. 2. Valida se encontrou a pessoa. VirtUau: - https://ajuda.globaltec.com.br/virtuau/integracao-uauweb-com-sites-de-clientesdata: {
. CodigoPessoa (integer)
. CpfCnpj (string)
} (object) required
post_api_v1_pessoas_alterar_conta_padraoDefinição Técnica: 1. Autenticar o usuário cliente URI + /api/vversion/Autenticador/AutenticarUsuario 2. Preencher os parâmetros de request para uso do método. Parâmetros da request 1. codigoPessoa: Código da Pessoa. 2. codigoBanco: Código do Banco. 3. agencia: Número da Agência. 4. conta: Conta.data: {
. CodigoPessoa (integer)
. CodigoBanco (integer)
. Agencia (string)
. Conta (string)
} (object) required
post_api_v1_pessoas_consultar_telefonesDefinição Técnica: 1. Autenticar o usuário cliente URI + /api/vversion/Autenticador/AutenticarUsuario 2. Preencher os parâmetros de request para uso do método. 3. Número de usuário é obrigatório. 4. Nível de permissão, GETELPES Consulta Definição de Negócio: 1. Listagem dos telefones relacionadas ao usuário.data: {
. Numero (integer)
} (object) required
post_api_v1_pessoas_alterar_senha_clienteDefinição Técnica: 1. Autenticar o usuário cliente URI + /api/vversion/Autenticador/AutenticarUsuario 2. Consultar os dados do usuário logado para obter o código do cliente URI + /api/vversion/Autenticador/ConsultarDadosUsrLogado 3. Preencher os parâmetros de request para uso do método. Definição de Negócio: Permite alterar a senha do cliente. 1. Deve informar o código do próprio cliente logado no Uau Web no qual será alterada a senha. 2. A senha deve conter exatamente 6 caracteres e nãdata: {
. codigo_cliente (integer)
. senha (string)
} (object) required
post_api_v1_pessoas_gravar_conta_bancariaDefinição Técnica: 1. Autenticar o usuário cliente URI + /api/vversion/Autenticador/AutenticarUsuario 2. Consultar o codigo da pessoa na rota URI +/api/vversion/Pessoas/ConsultarDadosPessoaPorCpfCnpjEStatus. 3. Preencher os parâmetros de request com os dados bancários e o código da pessoa para uso do método. Informação: 1. Cuidado ao alterar, compartilhar e/ou distribuir informações pessoais do cliente, fornecedor, funcionário e/ou prospect, considere avaliar se o processo que esta realidata: {
. codigoPessoa (integer)
. banco (integer)
. conta (string)
. padrao (boolean)
. tipo (integer)
. agencia (string)
. nomeAgencia (string)
. debitoAutomatico (boolean)
} (object) required
post_api_v1_pessoas_consultar_tipo_enderecoConsultar tipo de endereço da pessoadata: {
. codigoPessoa (integer)
} (object) required
post_api_v1_pessoas_criar_credenciais_uauwebDefinição Técnica: 1. Autenticar o usuário cliente URI + /api/vversion/Autenticador/AutenticarUsuario 2. Preencher os parâmetros de request com os dados do usuário para uso do método. Regras de Negócio: 1. É necessário que o usuario forneça o UsuarioUAUSite ao obter o token de autenticação. 2. O usuário não pode estar duplicado no banco de dados. 3. O Email não pode estar sendo utilizado por outra pessoa. 4. O usuário não pode já ter um Login UAUWeb. 5. O novo login não pode estar senddata: {
. CPF (string)
. DataNascimento (string)
. Login (string)
. Senha (string)
. Email (string)
} (object) required
post_api_v1_pessoas_consultar_pessoa_por_chaveDefinição Técnica: 1. Autenticar o usuário cliente URI + /api/vversion/Autenticador/AutenticarUsuario 2. Preencher os parâmetros de request para uso do método. Definição de Negócio: 1. Cosulta os dados de uma pessoa filtrando pelo código. Informação: 1. Cuidado ao alterar, compartilhar e/ou distribuir informações pessoais do cliente, fornecedor, funcionário e/ou prospect, considere avaliar se o processo que esta realizando esta de acordo com os termos da Lei geral de proteção de dadosdata: {
. codigo_pessoa (integer)
} (object) required
post_api_v1_pessoas_consultar_contas_bancariasDefinição Técnica: 1. Autenticar o usuário cliente URI + /api/vversion/Autenticador/AutenticarUsuario 2. Consultar o codigo da pessoa na rota URI +/api/vversion/Pessoas/ConsultarDadosPessoaPorCpfCnpjEStatus. 3. Informar o código da pessoa para uso do método. VirtUau: - https://ajuda.globaltec.com.br/virtuau/integracao-uauweb-com-sites-de-clientesdata: {
. codigo (string)
} (object) required
post_api_v1_pessoas_consultar_pessoas_com_vendaDefinição Técnica: 1. Autenticar o usuário cliente URI + /api/vversion/Autenticador/AutenticarUsuario 2. Preencher os parâmetros de request para uso do método. 3. Retorna código de nome da pessoa. Definição de Negócio: 1. As vendas podem ser quitadas ou não.No parameters
post_api_v1_pessoas_alterar_pessoa_acesso_portalDefinição Técnica: 1. Autenticar o usuário cliente URI + /api/vversion/Autenticador/AutenticarUsuario 2. Consultar os dados do usuário logado para obter o código do cliente URI + /api/vversion/Autenticador/ConsultarDadosUsrLogado 3. Preencher os parâmetros de request para uso do método. Definição de Negócio: Permite alterar os dados de acesso ao Uau Web login, senha e e-mail. 1. Deve informar o código do próprio cliente logado no Uau Web no qual serão atualizados os dados. 2. A senha dedata: {
. codigo_pessoa (integer)
. login (string)
. senha (string)
. email (string)
} (object) required
post_api_v1_pessoas_consultar_pessoas_por_cpfcnpjDefinição Técnica: 1. Autenticar o usuário cliente URI + /api/vversion/Autenticador/AutenticarUsuario 2. Preencher os parâmetros de request para uso do método. 3. Deve informar o CPF/CNPJ sem formatações e o status. 4. O status pode ser: - 0 = Ativo - 1 = Inativo - 2 = Ambos Definição de Negócio: Permite obter os dados de determinada pessoa física ou jurídica. Informação: 1. Cuidado ao alterar, compartilhar e/ou distribuir informações pessoais do cliente, fornecedor,data: {
. cpf_cnpj (string)
. status (integer)
} (object) required
post_api_v1_pessoas_excluir_banco_econta_por_chaveDefinição Técnica: 1. Autenticar o usuário cliente URI + /api/vversion/Autenticador/AutenticarUsuario 2. Consultar o codigo da pessoa na rota URI +/api/vversion/Pessoas/ConsultarDadosPessoaPorCpfCnpjEStatus. 3. Consultar os dados bancarios da pessoa na rota URI +/api/vversion/Pessoas/ConsultarContasBancarias. 4. Preencher os parâmetros de request com os dados bancários e o código da pessoa para uso do método. Regras de Negócio: 1. Valida usuário e permissões. Informação: 1. Cuidadodata: {
. codigoPessoa (integer)
. banco (integer)
. conta (string)
. agencia (string)
} (object) required
post_api_v1_pessoas_recuperar_credenciais_uauwebDefinição Técnica: 1. Autenticar o usuário cliente URI + /api/vversion/Autenticador/AutenticarUsuario 2. Preencher os parâmetros de request com o login ou o email do usuário da pessoa para uso do método. Regras de Negócio: 1. É necessário que o usuário forneça o UsuarioUAUSite ao obter o token de autenticação. 2. O usuário logado informado na rota de autenticação deverá possuir configuração de email cadastrada. Para verificar, acesse a Tela de Configurações do Usuário - Configurações -data: {
. Login (string)
. Email (string)
} (object) required
post_api_v1_pessoas_consultar_pessoas_por_condicaoDefinição Técnica: 1. Autenticar o usuário cliente URI + /api/vversion/Autenticador/AutenticarUsuario 2. Preencher os parâmetros de request para uso do método. 3. A condição informada é uma clausula SQL pós WHERE, segue exemplo: - cpf_pes = '12345678910' AND nome_pes LIKE 'GLOBALTEC%' 4. Devem ser passado as aspas simples para campos string. Definição de Negócio: 1. Consulta pessoa por condição informada. 2. Valida a condição da consulta, evitando SQL Injection. Informação: 1data: {
. condicaoConsultarPessoa (string)
} (object) required
post_api_v1_pessoas_importar_dados_pessoas_para_uauDefinição Técnica: 1. Autenticar o usuário cliente URI + /api/vversion/Autenticador/AutenticarUsuario 2. Preencher os parâmetros de request para uso do método. 3. Deve seguir arquivo XSD com o formato aceito. Definição de Negócio: 1. Realiza a importação dos dados de pessoas para o UAU atravéz de arquivo XML. 2. Será validado o xml deserializado que preenche a classe de importação validando os dados. Informação: 1. Cuidado ao alterar, compartilhar e/ou distribuir informações pessoaidata: {
. xml (string)
} (object) required
post_api_v1_pessoas_consultar_telefone_pes_por_chaveDefinição Técnica: 1. Autenticar o usuário cliente URI + /api/vversion/Autenticador/AutenticarUsuario 2. Consultar o codigo da pessoa na rota URI +/api/vversion/Pessoas/ConsultarDadosPessoaPorCpfCnpjEStatus. 3. Preencher os parâmetros de request para uso do método. Informação: 1. Cuidado ao alterar, compartilhar e/ou distribuir informações pessoais do cliente, fornecedor, funcionário e/ou prospect, considere avaliar se o processo que esta realizando esta de acordo com os termos da Lei gedata: {
. codigoPessoa (integer)
} (object) required
post_api_v1_pessoas_consultar_endereco_pessoas_por_chaveDefinição Técnica: 1. Autenticar o usuário cliente URI + /api/vversion/Autenticador/AutenticarUsuario 2. Preencher os parâmetros de request para uso do método. Informação: 1. Cuidado ao alterar, compartilhar e/ou distribuir informações pessoais do cliente, fornecedor, funcionário e/ou prospect, considere avaliar se o processo que esta realizando esta de acordo com os termos da Lei geral de proteção de dados LGPD N.13.709.data: {
. codigoPessoa (integer)
. tipoEndereco (integer)
} (object) required
post_api_v1_pessoas_consultar_pessoas_funcionarios_ativosInformação: 1. Cuidado ao alterar, compartilhar e/ou distribuir informações pessoais do cliente, fornecedor, funcionário e/ou prospect, considere avaliar se o processo que esta realizando esta de acordo com os termos da Lei geral de proteção de dados LGPD N.13.709.data: {
. Page (integer)
. PageSize (integer)
. SearchText (string)
} (object) required
post_api_v1_pessoas_consultar_dados_pessoa_fisica_por_codigoDefinição Técnica: 1. Autenticar o usuário cliente URI + /api/vversion/Autenticador/AutenticarUsuario 2. Preencher os parâmetros de request para uso do método. Definição de Negócio: 1. Consulta dados de pessoa física filtrando pelo código da pessoa. Informação: 1. Cuidado ao alterar, compartilhar e/ou distribuir informações pessoais do cliente, fornecedor, funcionário e/ou prospect, considere avaliar se o processo que esta realizando esta de acordo com os termos da Lei geral de proteçdata: {
. codigopessoa_fis (integer)
} (object) required
post_api_v1_pessoas_consultar_dados_pessoa_por_cpf_cnpj_estatusDefinição Técnica: 1. Autenticar o usuário cliente URI + /api/vversion/Autenticador/AutenticarUsuario 2. Informar o CPF/CNPJ e status da pessoa para uso do método. Regras de Negócio: 1. CPF/CNPJ aceita apenas números. 2. Valida se encontrou a pessoa. Informação: 1. Cuidado ao alterar, compartilhar e/ou distribuir informações pessoais do cliente, fornecedor, funcionário e/ou prospect, considere avaliar se o processo que esta realizando esta de acordo com os termos da Lei geral de protedata: {
. cpf_cnpj (string)
. status (integer)
} (object) required
post_api_v1_pessoas_consultar_dados_adicionais_pessoa_por_chaveDefinição Técnica: 1. Autenticar o usuário cliente URI + /api/vversion/Autenticador/AutenticarUsuario 2. Preencher os parâmetros de request para uso do método. Definição de Negócio: 1. Busca por dados adicionais de pessoa filtrando pela chave. Informação: 1. Cuidado ao alterar, compartilhar e/ou distribuir informações pessoais do cliente, fornecedor, funcionário e/ou prospect, considere avaliar se o processo que esta realizando esta de acordo com os termos da Lei geral de proteção dedata: {
. codigo_pessoa (integer)
} (object) required
post_api_v1_planejamento_atualizar_item_planejamentoDefinição Técnica: 1. Autenticar o usuário cliente URI + /api/vversion/Autenticador/AutenticarUsuario 2. Preencher os parâmetros de request para uso do método.data: {
. Empresa (integer)
. Obra (string)
. Produto (string)
. Contrato (string)
. Item (string)
. DescricaoItem (string)
. Usuario (string)
} (object) required
post_api_v1_planejamento_consultar_item_planejamentoDefinição Técnica: 1. Autenticar o usuário cliente URI + /api/vversion/Autenticador/AutenticarUsuario 2. Preencher os parâmetros de request para uso do método.data: {
. Empresa (integer)
. Obra (string)
. Produto (string)
. Contrato (string)
. Item (string)
} (object) required
post_api_v1_planejamento_consultar_saldo_siplanejadaDefinição Técnica: 1. Autenticar o usuário cliente URI + /api/vversion/Autenticador/AutenticarUsuario 2. Preencher os parâmetros de request para uso do método. 3. Necessário permissão de consulta no programa OBPLNOBRdata: {
. Empresa (integer)
. Obra (string)
. Produto (integer)
. Contrato (integer)
. Item (string)
. Servico (string)
. MesPl (string)
. Insumo (string)
} (object) required
post_api_v1_planejamento_inserir_servico_planejamentoDefinição Técnica: 1. Autenticar o usuário cliente URI + /api/vversion/Autenticador/AutenticarUsuario 2. Preencher os parâmetros de request para uso do método.data: {
. Empresa (integer)
. Obra (string)
. Produto (string)
. Contrato (string)
. Item (string)
. Servico (string)
. TipoDeCusto (string)
. Usuario (string)
} (object) required
post_api_v1_planejamento_exportar_planejamento_produtoDefinição Técnica: 1. Autenticar o usuário cliente URI + /api/vversion/Autenticador/AutenticarUsuario 2. Preencher os parâmetros de request para uso do método.data: {
. Empresa (integer)
. Obra (string)
. Contrato (integer)
. Produto (integer)
} (object) required
post_api_v1_planejamento_atualizar_insumos_planejamentoDefinição Técnica: 1. Autenticar o usuário cliente URI + /api/vversion/Autenticador/AutenticarUsuario 2. Preencher os parâmetros de request para uso do método. 3. Necessário permissão de alteração no programa OBPLNOBRdata: {
. Insumos (array)
. justificativaAprovacaoPl (string)
} (object) required
post_api_v1_planejamento_atualizar_servico_planejamentoDefinição Técnica: 1. Autenticar o usuário cliente URI + /api/vversion/Autenticador/AutenticarUsuario 2. Preencher os parâmetros de request para uso do método.data: {
. Empresa (integer)
. Obra (string)
. Produto (string)
. Contrato (string)
. Item (string)
. Servico (string)
. Qtde (number)
. DataInicio (string)
. DataTermino (string)
. Usuario (string)
} (object) required
post_api_v1_planejamento_consultar_servico_planejamentoDefinição Técnica: 1. Autenticar o usuário cliente URI + /api/vversion/Autenticador/AutenticarUsuario 2. Preencher os parâmetros de request para uso do método.data: {
. Empresa (integer)
. Obra (string)
. Produto (string)
. Contrato (string)
. Item (string)
. Servico (string)
} (object) required
post_api_v1_planejamento_consultar_solicitacao_insumo_plDefinição Técnica: 1. Autenticar o usuário cliente URI + /api/vversion/Autenticador/AutenticarUsuario 2. Preencher os parâmetros de request para uso do método.data: {
. numSolicitacao (integer)
} (object) required
post_api_v1_planejamento_inserir_estrutura_planejamentoDefinição Técnica: 1. Autenticar o usuário cliente URI + /api/vversion/Autenticador/AutenticarUsuario 2. Preencher os parâmetros de request para uso do método.data: {
. Empresa (integer)
. Obra (string)
. Produto (string)
. Contrato (string)
. Item (string)
. Servico (string)
. Sequencia (string)
. CodigoItem (string)
. Tipo (integer)
. Qtde (number)
. Usuario (string)
} (object) required
post_api_v1_planejamento_consultar_solicitacao_servico_plDefinição Técnica: 1. Autenticar o usuário cliente URI + /api/vversion/Autenticador/AutenticarUsuario 2. Preencher os parâmetros de request para uso do método.data: {
. numSolicitacao (integer)
} (object) required
post_api_v1_planejamento_inserir_servico_planejamento_mesDefinição Técnica: 1. Autenticar o usuário cliente URI + /api/vversion/Autenticador/AutenticarUsuario 2. Preencher os parâmetros de request para uso do método.data: {
. Empresa (integer)
. Obra (string)
. Produto (string)
. Contrato (string)
. Item (string)
. Servico (string)
. Mes (string)
. Qtde (number)
. Usuario (string)
} (object) required
post_api_v1_planejamento_aprovar_solicitacao_planejamentoDefinição Técnica: 1. Autenticar o usuário cliente URI + /api/vversion/Autenticador/AutenticarUsuario 2. Preencher os parâmetros de request para uso do método. 3. Exemplo do json de request: 'NumSolicitacao' 622, 'Usuario': 'root', 'Departamento': 'FIN', 'Cargo': '10'data: {
. NumSolicitacao (integer)
. Usuario (string)
. Departamento (string)
. Cargo (string)
} (object) required
post_api_v1_planejamento_atualizar_estrutura_planejamentoDefinição Técnica: 1. Autenticar o usuário cliente URI + /api/vversion/Autenticador/AutenticarUsuario 2. Preencher os parâmetros de request para uso do método.data: {
. Empresa (integer)
. Obra (string)
. Produto (string)
. Contrato (string)
. Item (string)
. Servico (string)
. Sequencia (string)
. Qtde (number)
. Usuario (string)
} (object) required
post_api_v1_planejamento_consultar_estrutura_planejamentoDefinição Técnica: 1. Autenticar o usuário cliente URI + /api/vversion/Autenticador/AutenticarUsuario 2. Preencher os parâmetros de request para uso do método.data: {
. Empresa (integer)
. Obra (string)
. Produto (string)
. Contrato (string)
. Item (string)
. Servico (string)
. Sequencia (string)
} (object) required
post_api_v1_planejamento_atualizar_servico_planejamento_mesDefinição Técnica: 1. Autenticar o usuário cliente URI + /api/vversion/Autenticador/AutenticarUsuario 2. Preencher os parâmetros de request para uso do método.data: {
. Empresa (integer)
. Obra (string)
. Produto (string)
. Contrato (string)
. Item (string)
. Servico (string)
. Mes (string)
. Qtde (number)
. Usuario (string)
} (object) required
post_api_v1_planejamento_consultar_desembolso_planejamentoDefinição Técnica: 1. Autenticar o usuário cliente URI + /api/vversion/Autenticador/AutenticarUsuario 2. Preencher os parâmetros de request para uso do método. 3. O mês inicial e final deverão ser informados no formato MM/YYYY. Exemplo: 01/2019, 12/2019. Definição de Negócio: Status: 1. Projetado: Considera a data de pagamento DtaRef para realizar o cálculo dos valores. 2. A pagar: Considera a data de prorrogação da parcela DtaRef para realizar o cálculo dos valores. 3. Pago: Consideradata: {
. Empresa (integer)
. Obra (string)
. MesInicial (string)
. MesFinal (string)
} (object) required
post_api_v1_planejamento_consultar_servico_planejamento_mesDefinição Técnica: 1. Autenticar o usuário cliente URI + /api/vversion/Autenticador/AutenticarUsuario 2. Preencher os parâmetros de request para uso do método.data: {
. Empresa (integer)
. Obra (string)
. Produto (string)
. Contrato (string)
. Item (string)
. Servico (string)
. Mes (string)
} (object) required
post_api_v1_planejamento_consultar_servico_planejamento_por_obraDefinição Técnica: 1. Autenticar o usuário cliente URI + /api/vversion/Autenticador/AutenticarUsuario 2. Preencher os parâmetros de request para uso do método.data: {
. Empresa (integer)
. Obra (string)
} (object) required
post_api_v1_planejamento_inserir_servico_planejamento_integradoDefinição Técnica: 1. Autenticar o usuário cliente URI + /api/vversion/Autenticador/AutenticarUsuario 2. Preencher os parâmetros de request para uso do método.data: {
. Empresa (integer)
. Obra (string)
. Produto (string)
. Contrato (string)
. Item (string)
. Servico (string)
. TipoDeCusto (string)
. CodigoExterno (string)
. Usuario (string)
} (object) required
post_api_v1_planejamento_recusar_solicitacao_planejamento_geralDefinição Técnica: 1. Autenticar o usuário cliente URI + /api/vversion/Autenticador/AutenticarUsuario 2. Preencher os parâmetros de request para uso do método.data: {
. NumSolicitacao (integer)
. NumSolicitacoes (array)
. IdsItensSolicitacao (array)
. Usuario (string)
. Departamento (string)
. Cargo (string)
} (object) required
post_api_v1_planejamento_aprovar_solicitacao_planejamento_em_loteDefinição Técnica: 1. Autenticar o usuário cliente URI + /api/vversion/Autenticador/AutenticarUsuario 2. Preencher os parâmetros de request para uso do método. 3. Exemplo do json de request: 'NumSolicitacoes' 625, 626 , 'Usuario': 'root', 'Departamento': 'FIN', 'Cargo': '10'data: {
. NumSolicitacoes (array)
. Usuario (string)
. Departamento (string)
. Cargo (string)
} (object) required
post_api_v1_planejamento_atualizar_servico_planejamento_integradoDefinição Técnica: 1. Autenticar o usuário cliente URI + /api/vversion/Autenticador/AutenticarUsuario 2. Preencher os parâmetros de request para uso do método.data: {
. CodigoExterno (string)
. Qtde (number)
. DataInicio (string)
. DataTermino (string)
. Usuario (string)
} (object) required
post_api_v1_planejamento_consultar_servico_planejado_desintegradoDefinição Técnica: 1. Autenticar o usuário cliente URI + /api/vversion/Autenticador/AutenticarUsuario 2. Preencher os parâmetros de request para uso do método.data: {
. Empresa (integer)
. Obra (string)
} (object) required
post_api_v1_planejamento_consultar_servico_planejamento_integradoDefinição Técnica: 1. Autenticar o usuário cliente URI + /api/vversion/Autenticador/AutenticarUsuario 2. Preencher os parâmetros de request para uso do método.data: {
. CodigoExterno (string)
} (object) required
post_api_v1_planejamento_consultar_aprovacao_pl_pendente_por_usuarioDefinição Técnica: 1. Autenticar o usuário cliente URI + /api/vversion/Autenticador/AutenticarUsuario 2. Preencher os parâmetros de request para uso do método.data: {
. usuario (string)
. departamento (string)
. cargo (string)
. empresasObras (string)
. tipoConsultaAprovacao (string)
. numero_dias (integer)
} (object) required
post_api_v1_planejamento_recusar_solicitacao_planejamento_geral_em_loteDefinição Técnica: 1. Autenticar o usuário cliente URI + /api/vversion/Autenticador/AutenticarUsuario 2. Preencher os parâmetros de request para uso do método.data: {
. NumSolicitacao (integer)
. NumSolicitacoes (array)
. IdsItensSolicitacao (array)
. Usuario (string)
. Departamento (string)
. Cargo (string)
} (object) required
post_api_v1_planejamento_aprovar_solicitacao_planejamento_insumos_em_loteDefinição Técnica: 1. Autenticar o usuário cliente URI + /api/vversion/Autenticador/AutenticarUsuario 2. Preencher os parâmetros de request para uso do método. 3. Exemplo do json de request: 'IdsItensSolicitacao' 1615, 1616, 1617 , 'Usuario': 'root', 'Departamento': 'FIN', 'Cargo': '10'data: {
. IdsItensSolicitacao (array)
. Usuario (string)
. Departamento (string)
. Cargo (string)
} (object) required
post_api_v1_planejamento_aprovar_solicitacao_planejamento_servicos_em_loteDefinição Técnica: 1. Autenticar o usuário cliente URI + /api/vversion/Autenticador/AutenticarUsuario 2. Preencher os parâmetros de request para uso do método. 3. Exemplo do json de request: 'NumSolicitacao': 630, 'ChavesServico': 'empresa': 1, 'obra': '00000', 'produto': 7, 'contrato': 1, 'item': '01.01.01.02', 'servico': '020201P', 'data': '01/09/20data: {
. NumSolicitacao (integer)
. ChavesServico (array)
. Usuario (string)
. Departamento (string)
. Cargo (string)
} (object) required
post_api_v1_planejamento_consultar_quantidade_aprovacao_pl_pendente_por_usuarioDefinição Técnica: 1. Autenticar o usuário cliente URI + /api/vversion/Autenticador/AutenticarUsuario 2. Preencher os parâmetros de request para uso do método.data: {
. usuario (string)
. departamento (string)
. cargo (string)
. empresasObras (string)
. tipoConsultaAprovacao (string)
. numero_dias (integer)
} (object) required
post_api_planejamento_obter_acesso_usuario_na_obraNo description availablelogin (string) required
empresa (string) required
obra (string) required
api-version (string)
post_api_v1_processo_pagamento_aprovar_dvqDefinição Técnica: 1. Autenticar o usuário cliente URI + /api/vversion/Autenticador/AutenticarUsuario Definição de Negócio: Permite a aprovação DVQ de parcelas específicas. 1. No request dvq deve ser informado qual a letra que será aprovada ou não. - Os seguintes parâmetros obrigatórios para aprovação da letra 'D': Confirmação de data - usrConfirmou - codigoEmpresa - codigoObra - numeroProcesso - numeroParcela - Os seguintes parâmetrosdata: {
. dvq (string)
. aprovar (boolean)
. usuario (string)
. sobreporAprovacoesDeOutrosUsuarios (boolean)
. parcelas (array)
} (object) required
post_api_v1_processo_pagamento_gerar_processobDefinição Técnica:/b brDados básicos para o funcionamento da API./br list type='bullet' item1. Autenticar o usuário cliente: URI + /api/vversion/Autenticador/AutenticarUsuario/item item2. Preencher os parâmetros de request para uso do método./item item3. a href='https://ajuda.globaltec.com.br/wp-content/uploads/dlm_uploads/2024/11/ProcessoPagamento_GerarProcesso-3.pdf' target='_blank'Documentação API - Gerar Processo Clique Aqui/a/item /list bDefinição de Negócio:/b brGera um procdata: {
. Empresa (integer)
. Obra (string)
. CodigoFornecedor (integer)
. TipoProcesso (integer)
. ControlarEstoque (integer)
. AcompanhaEntrega (integer)
. DataPrevisaoEntrega (string)
. TipoItem (integer)
. HistoricoLancContabil (string)
. HistoricoLancContabilPago (string)
. CategoriaMovimentacaoFinanceira (string)
. NumeroContrato (integer)
. Parametro (object)
. Parcelas (array)
. Itens (array)
. DescontoVinculado (array)
. SolicitacaoCaixaObra (object)
. PermiteBoletoVencido (boolean)
} (object) required
post_api_v1_processo_pagamento_gerar_nota_fiscalDefinição Técnica: 1. Autenticar o usuário cliente URI + /api/vversion/Autenticador/AutenticarUsuario 2. Preencher os parâmetros de request para uso do método. Definição de Negócio: Gerar nota fiscal de entrada de acordo com os dados do processo 1. É obrigatório informar os dados básicos da nota fiscal. 2. O usuário autenticado precisa ter acesso a empresa e obra que está fazendo a requisição; 3. O usuário autenticado precisa ter acesso aos programas de permissão necessários para fazdata: {
. Empresa (integer)
. Obra (string)
. NumeroProcesso (integer)
. Parcela (integer)
. TipoNF (integer)
. Especie (string)
. Serie (string)
. NFEletronica (boolean)
. ChaveNfe (string)
. NumeroNotaFiscal (string)
. CodigoRemetente (integer)
. DataEmissao (string)
. DataDeEmissaoMaiorQueCadastro (boolean)
. DataEntrada (string)
. DataDeEntradaMaiorQueCadastro (boolean)
. ModeloNF (integer)
. ArqNotaFiscal (string)
. CaminhoOrigemArquivoLocal (string)
. CaminhoDestinoArquivo (string)
. NomeArquivo (string)
. CopiarArquivo (boolean)
. VincularADescontos (boolean)
} (object) required
post_api_v1_processo_pagamento_aprovar_processosDefinição Técnica: 1. Autenticar o usuário cliente URI + /api/vversion/Autenticador/AutenticarUsuario Definição de Negócio: 2. O Usuário informado precisa ter a permissão FICHEQUE para aprovar as parcelas do processo. 3. As parcelas precisam estar no 'Emissão de Pagamentos' para serem aprovadas. 4. Todos os parâmetros são obrigatórios.data: {
. processos (array)
} (object) required
post_api_v1_processo_pagamento_emissao_pagamentoDefinição Técnica: 1. Autenticar o usuário cliente URI + /api/vversion/Autenticador/AutenticarUsuario 2. Preencher os parâmetros de request para uso do método. 3. Rota destinada para emitir processos de pagamento que estão prontos aprovados para serem emitidos. Definição de negócio: 1. Emissão será realizada somente para processos aprovados com Tipo de Emissão 'Débito CC'; 2. Validar status da parcela como 2 - Reprovado, não deve enviar; 3. Verifica se existe alguma restriçãoOcorrênciadata: {
. parcelas (array)
} (object) required
post_api_v1_processo_pagamento_acrescimo_descontoSempre é lançado um novo acréscimo/desconto Parâmetros do Request: Empresa, Obra, NumeroDoProcesso e NumeroDaParcela são obrigatórios e identificam o processo; Data: Data do acréscimo a ser inserido no processo; Valor: Valor do acréscimo ou desconto. Positivo = acréscimo, negativo = desconto. Percentuais não são aceitos; Descricao: Texto livre limitado conforme tabela do banco de dados; CAP: Código fiscal a ser utilizado no processamento contábil do ajuste; HistoricoContabil: Texto opciondata: {
. Empresa (integer)
. Obra (string)
. NumeroDoProcesso (integer)
. NumeroDaParcela (integer)
. Data (string)
. Valor (number)
. Descricao (string)
. CAP (string)
. HistoricoContabil (string)
. TipoCalc (integer)
} (object) required
post_api_v1_processo_pagamento_consultar_processosDefinição Técnica: 1. Autenticar o usuário cliente URI + /api/vversion/Autenticador/AutenticarUsuario Definição de Negócio: Permite que você consulte os processos de pagamento por um número e/ou período específico. 1. Você pode consultar informando uma lista dos números dos processos de pagamento, código da empresa e código da obra cadastrados no UAU. 2. Você pode consultar processos de pagamento informado uma lista de código da empresa e código da obra cadastrado no UAU por um determinaddata: {
. Processos (array)
. EmpresaObraPeriodo (object)
. FornecedorPeriodo (object)
} (object) required
post_api_v1_processo_pagamento_manutencao_processobDefinição Técnica:/b brDados básicos para o funcionamento da API./br list type='bullet' item1. Autenticar o usuário cliente: URI + /api/vversion/Autenticador/AutenticarUsuario/item item2. Consultar os dados de um processo de pagamento: URI + /api/vversion/ProcessoPagamento/ConsultarProcessos/item item3. Preencher os parâmetros de request para uso do método./item item4. a href='https://ajuda.globaltec.com.br/wp-content/uploads/dlm_uploads/2024/11/ProcessoPagamento_ManutencaoProcessdata: {
. Numero (integer)
. Empresa (integer)
. Obra (string)
. CodigoFornecedor (integer)
. CodigoNovoBeneficiario (integer)
. Antecipado (boolean)
. Retroacao (integer)
. CodigoDepartamento (string)
. TipoJuros (integer)
. TaxaJurosAtraso (number)
. TaxaMultaAtraso (number)
. ChaveNfe (string)
. Parcela (object)
. NumeroProtocolo (integer)
. PermiteBoletoVencido (boolean)
} (object) required
post_api_v1_processo_pagamento_retornar_parcelas_dvqDefinição Técnica: 1. Autenticar o usuário cliente URI + /api/vversion/Autenticador/AutenticarUsuario 2. Preencher os parâmetros de request para uso do método. Definição de Negócio: 1. Os campos empresa, obra e usuário são obrigatórios. 2. É validado se o usuário existe no banco de dados, e se tem permissão na empresa e obra informada. 3. Data e Fornecedor devem está vazio ou sem o parâmetro informado na requisição para não serem considerados na consulta. 4. Número processonumeroproc edata: {
. Usuario (string)
. Empresa (integer)
. Obra (string)
. numeroproc (integer)
. fornecedor (string)
. notafiscal (integer)
. inicial (string)
. final (string)
} (object) required
post_api_v1_processo_pagamento_gerar_processo_medicaoDefinição Técnica: 1. Autenticar o usuário cliente URI + /api/vversion/Autenticador/AutenticarUsuario 2. Preencher os parâmetros de request para uso do método. Definição de Negócio: Gerar processo de pagamento de medição de contrato de material/serviço 1. É obrigatório informar os dados básicos do processo de pagamento; 2. O usuário autenticado precisa ter acesso a empresa e obra que está fazendo a requisição; 3. O usuário autenticado precisa ter acesso a aos programas de permissão ndata: {
. Empresa (integer)
. Contrato (integer)
. Medicao (integer)
. MesPlanejamento (string)
. ControlarEstoque (integer)
. AcompanhaEntrega (integer)
. DataPrevisaoEntrega (string)
. HistoricoLancContabilApagar (string)
. HistoricoLancContabilPago (string)
. HistoricoLancContabilDescNormalMed (string)
. CategoriaMovimentacaoFinanceira (string)
. Parametro (object)
. DocumentoFiscal (object)
. Parcelas (array)
. Itens (array)
} (object) required
post_api_v1_processo_pagamento_manutencao_parcelas_processoDefinição Técnica: 1. Autenticar o usuário cliente URI + /api/vversion/Autenticador/AutenticarUsuario 2. Preencher os parâmetros de request para uso do método. Definição de Negócio: Permite dar manutenção nas parcelas do processo de pagamento. Ao informar os dados para as novas parcelas, será simulado e gerado automaticamente as novas parcelas com novas numerações, valores e data de vencimento. Será excluido as parcelas informadas no request, pois foram substituídas pelas novas parcelas gdata: {
. codigoEmpresa (integer)
. codigoObra (string)
. numeroProcesso (integer)
. dataVencimento (string)
. qtdeParcelas (integer)
. intervaloParcelas (integer)
. listaParcelasManutencao (array)
. listaValoresNovasParcelas (array)
. listaValoresAcrescimoNovasParcelas (array)
. listaDataVencimentoNovasParcelas (array)
} (object) required
post_api_v1_processo_pagamento_confirmar_processo_para_emissaoDefinição Técnica: 1. Autenticar o usuário cliente URI + /api/vversion/Autenticador/AutenticarUsuario 2. Preencher os parâmetros de request para uso do método. 3. Valida se foram selecionadas parcelas de processos diferentes com tipos de Internos e Externos, ou seja, só pode confirmar parcelas de processos com mesmo tipo, ou todos internos ou todos externos; Definição de negócio: 1. Valida se parcela tem confirmação de DVQ; 2. Valida se a parcela tem banco e conta informado, e Tipo de emdata: {
. parcelas (array)
} (object) required
post_api_v1_processo_pagamento_gerar_nota_fiscal_produto_pelo_xmlCriação : Augusto Rabelo Barbosa Data: 28/05/2022 Projeto : 442112 Alteração : Elenildo Barbosa de Sousa Data: 03/01/2023 Projeto : 443200 Manutenção: Foi alterado a passagem de parâmetro do metodo BuscarArquivoDiretorioChave. Alteração : Augusto Rabelo Barbosa data: 04/01/2023 Projeto : 443200 Manutenção : Alterei o enumerador de importação de nota, passando a utilizar o TiposImportacao do EnumeradoresGerais Alteração : Augusto Rabelo Barbosa Dadata: {
. ChaveNFe (string)
. ArquivoXML (string)
. Empresa (integer)
. Obra (string)
. Processo (integer)
. Parcela (integer)
. VincularADescontos (boolean)
} (object) required
post_api_v1_processo_pagamento_gerar_nota_fiscal_servico_pelo_xmlCriação : Augusto Rabelo Barbosa Data: 03/11/2022 Projeto : 442112 Alteração : Elenildo Barbosa de Sousa Data: 03/01/2023 Projeto : 443200 Manutenção: Foi alterado a passagem de parâmetro do metodo BuscarArquivoDiretorioChave. Alteração : Augusto Rabelo Barbosa Data: 01/06/2023 Projeto : 454022 Manutenção: Inserido a validação VerificarSeProcessoFrete, para que seja feito a validação do processo de frete. Alteração : Juliana Oliveira Souza Data: 1data: {
. CodigoFornecedor (integer)
. Numero (string)
. ChaveNFSe (string)
. ArquivoXML (string)
. Empresa (integer)
. Obra (string)
. Processo (integer)
. Parcela (integer)
. VincularADescontos (boolean)
} (object) required
post_api_v1_processo_pagamento_integrar_processo_pagamento_uauwsDefinição Técnica: 1. Autenticar o usuário cliente URI + /api/vversion/Autenticador/AutenticarUsuario 2. Preencher os parâmetros de request para uso do método. 3. Deve seguir arquivo XSD como formato aceito. 4. Os campos do tipo data devem obedecer o formato específico yyyy-MM-dd. Definição de negócio: 1. Realiza a importação dos dados de processo de pagamento para o UAU de acordo com o arquivo XML. 2. Será validado os dados do XML para realizar a importação, bem como tipagem de dados,data: {
. xml_proc (string)
} (object) required
post_api_v1_processo_pagamento_gerar_nota_fiscal_transporte_pelo_xmlCriação : Augusto Rabelo Barbosa Data: 03/11/2022 Projeto : 442112 Alteração : Elenildo Barbosa de Sousa Data: 03/01/2023 Projeto : 443200 Manutenção: Foi alterado a passagem de parâmetro do metodo BuscarArquivoDiretorioChave. Alteração: Augusto Rabelo Barbosa data: 04/01/2023 Projeto: 443200 Manutenção: Alterei o enumerador de importação de nota, passando a utilizar o TiposImportacao do EnumeradoresGerais Alteração : Augusto Rabelo Barbosa Data: 01data: {
. ChaveCTe (string)
. ArquivoXML (string)
. Empresa (integer)
. Obra (string)
. Processo (integer)
. Parcela (integer)
. VincularADescontos (boolean)
} (object) required
post_api_processo_pagamento_conta_processo_emissao_pagamento_resumidoCriação : Nelson Plínio Data: 10/04/16 Projeto : 310963 - Propósito: Contar os processos de emissão de pagamentologin_usuario (string) required
api-version (string)
post_api_processo_pagamento_consultar_quantidade_processos_aprovar_dvqCriação : Nelson Plínio Data: 10/04/2019 Projeto : 310963login_usuario (string) required
api-version (string)
post_api_processo_pagamento_valida_dados_pagamento_para_aceitar_pix_copia_colaValidações dos dados de pagamento para o aceite da inserção do Pix Copia e Cola no processo de pagamento.banco (string) required
conta (string) required
tipoEmissao (string) required
formaPagamento (string) required
tipoPagamento (string) required
api-version (string)
post_api_processo_pagamento_valida_dados_pagamento_para_aceitar_codigo_de_barrasValidações dos dados de pagamento para o aceite da inserção do Código de Barras no processo de pagamento.banco (string) required
conta (string) required
tipoEmissao (string) required
formaPagamento (string) required
tipoPagamento (string) required
api-version (string)
post_api_v1_proposta_gerar_boletoDefinição Técnica: 1. Autenticar o usuário cliente URI + /api/vversion/Autenticador/AutenticarUsuario 2. Preencher os parâmetros de request para uso do método. 3. Retorna string do tipo Base64. Para obter o boleto utilize um conversor: Base64 para PDF. Definição de Negócio: 1. Gera boleto com os dados informados na request. 2. O usuário autenticado deve ter permissão de inclusão no programa de permissão VEBOLETOAVULSO. 3. Para gerar boleto parcial é necessário informar a propriedata: {
. parcelas (array)
. datacalculo (string)
. antecipar (boolean)
. reajustar (boolean)
. excluirboletoexpirado (boolean)
. formacobranca (integer)
. boletosacadodetalhado (boolean)
. carnetresvias (boolean)
. validardadospendentes (boolean)
. acrescentarresiduo (boolean)
. usarpadraoboletoavulso (boolean)
. agruparparcelas (boolean)
. ValorBoleto (number)
. PadraoCobranca (integer)
. ExcluirBoletosExistentes (boolean)
} (object) required
post_api_v1_proposta_expirar_boletosDefinição Técnica: 1. Autenticar o usuário cliente URI + /api/vversion/Autenticador/AutenticarUsuario 2. Preencher os parâmetros de request para uso do método. Definição de Negócio: 1. Exclui todos os boletos expirados, propostas e vendas, de acordo com a configuração da empresa.No parameters
post_api_v1_proposta_gravar_propostaDefinição Técnica: 1. Autenticar o usuário cliente URI + /api/vversion/Autenticador/AutenticarUsuario 2. Preencher os parâmetros de request para uso do método. Definição de Negócio: 1. O usuário autenticado deve ter permissão de inclusão e alteração em CRPROPOSTAVENDA. - Se não precisar de alterar propostas, basta ter apenas de inclusão. 2. A alteração de uma proposta é feita respeitando todas informações enviadas, ou seja, deve reeniviar o mesmo objeto da proposta totalmentedata: {
. proposta (object)
. propostaPacelasGeradas (array)
. propostaParamModeloParcelas (array)
. propostaParamParcelas (array)
. propostaComissao (array)
. propostaComissaoParc (array)
. propostaItens (array)
. propostaCliente (array)
. propostaPlanoIndex (array)
. propostaSeguro (array)
. propostaCustasRetencao (object)
. propostaCustasRetencaoParcela (array)
. propostaCap (array)
. propostaShopping (object)
} (object) required
post_api_v1_proposta_cancelar_propostaDefinição Técnica: 1. Autenticar o usuário cliente URI + /api/vversion/Autenticador/AutenticarUsuario 2. Preencher os parâmetros de request para uso do método. Definição de Negócio: 1. É obrigatório informar o código da proposta. 2. Caso ela esteja vendida, deve informar se é para cancela-la ou não. 3. A proposta não pode estar cancelada ou expirada 4. Ao enviar ExcluirBoletos como TRUE, irá excluir os boletos ativos da proposta e permitir o cancelamento.data: {
. numeroProposta (integer)
. cancelarVendida (boolean)
. ExcluirBoletos (boolean)
} (object) required
post_api_v1_proposta_renegociar_propostaDefinição Técnica: 1. Autenticar o usuário cliente URI + /api/vversion/Autenticador/AutenticarUsuario 2. Preencher os parâmetros de request para uso do método. Definição de Negócio: Permite renegociar parcelas de uma proposta 1. O usuário deverá estar autenticado e validado. 2. Informar os dados da proposta. 3. Informar as parcelas a serem geradas. 4. Informar as parcelas escolhidas para renegociação. 6. Será realizada validação referente as informações preenchidas que irão permitirdata: {
. NumProposta (integer)
. PropostaParcelasGeradas (array)
. ParcelasSelecionadas (array)
. ValorDesconto (number)
. ValorAcrescimo (number)
. valorCurtoPrazo (number)
. valorLongoPrazo (number)
. NumPadraoCobranca (integer)
. TermoReserva (integer)
} (object) required
post_api_v1_proposta_consultar_proposta_por_idDefinição Técnica: 1. Autenticar o usuário cliente URI + /api/vversion/Autenticador/AutenticarUsuario 2. Preencher os parâmetros de request para uso do método. Definição de Negócio: 1. Busca determinada proposta filtrando por ID. 2. Valida usuário e suas permissões. 3. O campo valorAntecipado e dataCalculo são opcionais, mas caso informado algum deles, precisa informar valor nos dois campos. - valorAntecipado deve ser preenchido com 0 para falso ou 1 para verdadeiro.data: {
. numProposta (integer)
. valorAntecipado (integer)
. dataCalculo (string)
} (object) required
post_api_v1_proposta_vincular_arquivo_propostaDefinição Técnica: 1. Autenticar o usuário cliente URI + /api/vversion/Autenticador/AutenticarUsuario 2. Preencher os parâmetros de request para uso do método. Definição de Negócio: 1. Realiza a vinculadção de arquivo com determinada proposta.data: {
. arquivo (string)
. nome_arquivo (string)
. proposta (integer)
. usuario (string)
} (object) required
post_api_v1_proposta_gravar_pedido_de_recebimentoDefinição Técnica: 1. Autenticar o usuário cliente URI + /api/vversion/Autenticador/AutenticarUsuario 2. Preencher os parâmetros de request para uso do método. Definição de Negócio: 1. É obrigatório ter o ambiente de integração com a NTK configurado, só após o registro junto a eles que o registro será gerado no UAU. 2. É necessário ter permissão de inclusão no programa VEPEDIDORECEBIMENTO 3. Não é possível gerar pedido para receber todas as parcelas de uma proposta, o sistema irá validardata: {
. Empresa (integer)
. Obra (string)
. NumContrato (integer)
. Estabelecimento (string)
. FormaPgto (integer)
. QtdeParcelas (integer)
. DataCalculo (string)
. ValorLiquido (number)
. TipoRecebimento (integer)
. Antecipacao (boolean)
. Parcelas (array)
} (object) required
post_api_v1_proposta_cancelar_pedido_de_recebimentoDefinição Técnica: 1. Autenticar o usuário cliente URI + /api/vversion/Autenticador/AutenticarUsuario Definição de Negócio: 1. Pedidos que já tiveram um recebimento parcial junto a NTK, não são cancelados. trava na NTK. 2. É necessário ter permissão de alteração no programa VEPEDIDORECEBIMENTOdata: {
. Empresa (integer)
. Obra (string)
. Pedido (integer)
} (object) required
post_api_v1_proposta_consultar_hierarquia_parcelasDefinição Técnica: 1. Autenticar o usuário cliente URI + /api/vversion/Autenticador/AutenticarUsuario 2. Preencher os parâmetros de request para uso do método. Definição de Negócio:data: {
. codigo (integer)
} (object) required
post_api_v1_proposta_atualizar_pedido_de_recebimentoDefinição Técnica: 1. Autenticar o usuário cliente URI + /api/vversion/Autenticador/AutenticarUsuario Definição de Negócio: 1. Serão atualizadas as parcelas do pedido que ainda estão com status: 0 - Em aberto 2. É necessário ter permissão de alteração no programa VEPEDIDORECEBIMENTOdata: {
. Empresa (integer)
. Obra (string)
. Pedido (integer)
} (object) required
post_api_v1_proposta_consultar_pedido_de_recebimentoDefinição Técnica: 1. Autenticar o usuário cliente URI + /api/vversion/Autenticador/AutenticarUsuario Definição de Negócio: 1. Possibilita consultar pedido de recebimento junto a NTK 2. As informações retornadas serão informações do pedido na NTK.data: {
. Empresa (integer)
. Obra (string)
. Pedido (integer)
} (object) required
post_api_v1_proposta_processar_recebimento_parcelasDefinição Técnica: 1. Autenticar o usuário cliente URI + /api/vversion/Autenticador/AutenticarUsuario 2. Preencher os parâmetros de request para uso do método. Definição de Negócio: 1. Processa as parcelas recebidas 2. O valor do desconto aplicado ao recebimento será sempre do objeto de recebimento, o valor do desconto da parcela será aplicado somente pela tela de recebimento avulso. 3. Não é possível realizar recebimento para todas as parcelas da proposta! Ao realizar o recebimento de pdata: {
. recebimento (object)
. formaPagamento (object)
} (object) required
post_api_v1_proposta_consultar_pedido_de_recebimento_uauDefinição Técnica: 1. Autenticar o usuário cliente URI + /api/vversion/Autenticador/AutenticarUsuario Definição de Negócio: 1. Possibilita consultar pedido de recebimento regisrado no UAU por número do pedido junto a NTK ou pelo número do pedido no UAU. 2. As informações retornadas são referentes a como o UAU registrou o pedido internamente.data: {
. NumeroNTK (integer)
. NumeroPedido (integer)
} (object) required
post_api_v1_proposta_retornar_valores_estrutura_comissaoDefinição Técnica: 1. Autenticar o usuário cliente URI + /api/vversion/Autenticador/AutenticarUsuario 2. Preencher os parâmetros de request para uso do método. Definição de Negócio: 1. Realiza cálculos da comissão e retorna os valores 2. Parâmetros: - Grupo de parcelas - Estrutura de comissãodata: {
. codigoEmpresa (integer)
. codigoObra (string)
. codigoVendedor (integer)
. codigoHierarquia (integer)
. codigoComissao (integer)
. valorTotalComissao (number)
. valorComissaoDireta (number)
. valorCurtoPrazoProposta (number)
. valorLongoPrazoProposta (number)
. produtos (array)
. parcelas (array)
} (object) required
post_api_v1_proposta_retorna_valor_comissao_deducao_parcelasDefinição Técnica: 1. Autenticar o usuário cliente URI + /api/vversion/Autenticador/AutenticarUsuario 2. Preencher os parâmetros de request para uso do método. Definição de Negócio: Calcula o valor da comissão deduzido.data: {
. CodigoHierarquia (integer)
. CodigoModeloVenda (integer)
. ValorTotalProduto (number)
. ValorTotalComissao (number)
. ValorTotalComissaoDireta (number)
. ParcelasGeradas (array)
. PorcentagemComissao (number)
. ValorItemProposta (number)
} (object) required
post_api_proposta_traduzir_request_parcelas_geradasNo description availableproposta (string) required
data (array) required
api-version (string)
post_api_proposta_traduzir_request_parcelas_selecionadasNo description availablenumProposta (string) required
data (array) required
api-version (string)
post_api_v1_prospect_gravar_prospectDefinição Técnica: 1. Autenticar o usuário cliente URI + /api/vversion/Autenticador/AutenticarUsuario 2. Preencher os parâmetros de request para uso do método. Definição de Negócio: 1. Grava as informações do prospect. 2. Os dados informados passam por validações. Informação: 1. Cuidado ao alterar, compartilhar e/ou distribuir informações pessoais do cliente, fornecedor, funcionário e/ou prospect, considere avaliar se o processo que esta realizando esta de acordo com os termos da Leidata: {
. permitirResponsavelSemEstrutura (boolean)
. login (string)
. prospect (object)
. prospectFis (object)
. prospectInteresse (object)
. prospectInteresseProdutos (array)
. prospectInteresseBairros (array)
. prospectTelefones (array)
. prospectEnderecoPrincipal (object)
. prospectEnderecoCobranca
. prospectEnderecoComercial
. prospectDependente (array)
. responsavel (string)
. buscouDePessoas (boolean)
. atualizarPessoas (boolean)
. mensagemRetorno (string)
. prospectDoc (array)
} (object) required
post_api_v1_prospect_importar_prospectDefinição Técnica: 1. Autenticar o usuário cliente URI + /api/vversion/Autenticador/AutenticarUsuario 2. Preencher os parâmetros de request para uso do método. Definição de Negócio: 1. Importa prospects para dentro do UAU. 2. Valida usuário e permissões. 3. Valida arquivo XML. Informação: 1. Cuidado ao alterar, compartilhar e/ou distribuir informações pessoais do cliente, fornecedor, funcionário e/ou prospect, considere avaliar se o processo que esta realizando esta de acordo com osdata: {
. xml (string)
} (object) required
post_api_v1_prospect_listar_grau_parentescoNo description availableNo parameters
post_api_v1_prospect_migrar_prospect_pessoaDefinição Técnica: 1. Autenticar o usuário cliente URI + /api/vversion/Autenticador/AutenticarUsuario 2. Preencher os parâmetros de request para uso do método. Definição de Negócio: 1. Migra um prospect para pessoa. Informação: 1. Cuidado ao alterar, compartilhar e/ou distribuir informações pessoais do cliente, fornecedor, funcionário e/ou prospect, considere avaliar se o processo que esta realizando esta de acordo com os termos da Lei geral de proteção de dados LGPD N.13.709.data: {
. numeroProspect (integer)
} (object) required
post_api_v1_prospect_consultar_todos_prospectsDefinição Técnica: 1. Autenticar o usuário cliente URI + /api/vversion/Autenticador/AutenticarUsuario 2. Preencher os parâmetros de request para uso do método. Definição de Negócio: 1. Consulta os prospects de acordo com os parâmetros definidos na request. Informação: 1. Cuidado ao alterar, compartilhar e/ou distribuir informações pessoais do cliente, fornecedor, funcionário e/ou prospect, considere avaliar se o processo que esta realizando esta de acordo com os termos da Lei geral dedata: {
. enumOpcaoTodos (integer)
. codigoProspect (string)
. codigoVendedor (integer)
} (object) required
post_api_v1_prospect_consultar_prospect_por_chaveDefinição Técnica: 1. Autenticar o usuário cliente URI + /api/vversion/Autenticador/AutenticarUsuario 2. Preencher os parâmetros de request para uso do método. Definição de Negócio: 1. Consulta determinado prospect filtrando pelo número deste prospect. Informação: 1. Cuidado ao alterar, compartilhar e/ou distribuir informações pessoais do cliente, fornecedor, funcionário e/ou prospect, considere avaliar se o processo que esta realizando esta de acordo com os termos da Lei geral de protdata: {
. codigoProspect (integer)
} (object) required
post_api_v1_prospect_alterar_responsavel_prospectDefinição Técnica: 1. Autenticar o usuário cliente URI + /api/vversion/Autenticador/AutenticarUsuario 2. Preencher os parâmetros de request para uso do método. Definição de Negócio: 1. Alterar responsável do prospect. 2. Os dados informados passam por validações. 3. O campo codEmpresa não é obrigatório, porém, se informado será validado se na configuração da empresa está marcado para 'Realizar venda somente se o vendedor estiver em uma estrutura de comissão', e caso o novo responsáveldata: {
. novoResponsavel (integer)
. codEmpresa (integer)
. numProspect (integer)
} (object) required
post_api_v1_prospect_consultar_prospect_com_filtroDefinição Técnica: 1. Autenticar o usuário cliente URI + /api/vversion/Autenticador/AutenticarUsuario 2. Preencher os parâmetros de request para uso do método. Definição de Negócio: 1. Consulta prospect filtrando os parâmentros inseridos da request. Informação: 1. Cuidado ao alterar, compartilhar e/ou distribuir informações pessoais do cliente, fornecedor, funcionário e/ou prospect, considere avaliar se o processo que esta realizando esta de acordo com os termos da Lei geral de proteçdata: {
. numeroOpcao (integer)
. numeroVisao (integer)
. prospectSemResponsavel (boolean)
. codigoResponsavel (string)
. nomePessoa (string)
. telefone (string)
. cpfCnpj (string)
. trataSemResponsavel (boolean)
. ufProsp (string)
} (object) required
post_api_v1_prospect_buscar_grau_parentesco_por_codigoNo description availabledata: {
. Codigo (integer)
} (object) required
get_api_v1_recebiveis_consultar_meios_preferenciais_recebimentoDefinição Técnica: 1. Autenticar o usuário cliente URI + /api/vversion/Autenticador/AutenticarUsuario Definição de Negócio: Permite consultar os meios preferenciais de recebimento que estão ativos.No parameters
get_api_v1_recebiveis_padrao_de_cobranca_by_id_empresa_by_num_padrao_cobrancaDefinição Técnica: 1. Autenticar o usuário cliente URI + /api/vversion/Autenticador/AutenticarUsuario 2. Preencher os parâmetros de request com os dados do usuário para uso do método. Regras de Negócio: 1. É necessário que exista uma empresa cadastrada. 2. Numero do padrão de cobrança 0 busca todos os padrões de cobrança.IdEmpresa (string) required
NumPadraoCobranca (string) required
post_api_v1_recebiveis_parcelas_ecobrancas_do_clienteDefinição Técnica: 1. Autenticar o usuário cliente URI + /api/vversion/Autenticador/AutenticarUsuario 2. Preencher os parâmetros de request para uso do método. Definição de Negócio: 1. Busca parcelas e cobranças em aberto do cliente, informando o CPF/CNPJ. 2. O parametro PesquisaPorNaoTitulares não é obrigatório, se não informado no request ou informado false, buscará somente dos clientes da venda que possuam o tipo 0 - Titular. Caso informado true buscará de todos os clientes da vedata: {
. Cpf (string)
. ValorReajustado (boolean)
. QtdeParcelas (integer)
. DataInicioVencimento (string)
. DataFimVencimento (string)
. PesquisaPorNaoTitulares (boolean)
} (object) required
post_api_v1_recebiveis_alterar_meio_preferencial_de_recebimento_da_parcelaDefinição Técnica: 1. Autenticar o usuário cliente URI + /api/vversion/Autenticador/AutenticarUsuario Definição de Negócio: Permite alteração na parcela do meio preferencial de recebimento. Permite consultar a alteração realizada na parcela.data: {
. Empresa (integer)
. Obra (string)
. Venda (integer)
. NumeroParcela (integer)
. TipoParcela (string)
. NumeroParcelaGeral (integer)
. MeioPreferencialRecebimento (integer)
} (object) required
post_api_v1_relatorio_irpf_gerar_pdfrel_irpfDefinição Técnica: 1. Autenticar o usuário cliente URI + /api/vversion/Autenticador/AutenticarUsuario 2. Seguir o modelo abaixo para preenchimento dos parâmetros de request para uso do método. - A ordem dos parâmetros 'Venda', 'Obra' e 'Empresa' é obrigatória. - Substituir cada parâmetro pelo valor correspondente: - 'Venda' - Número da Venda. - 'Obra' - Código da Obra. - 'Empresa' - Número da Empresa. - 'ano_base' - ano base para geração do IRPF.data: {
. vendasobras_empresa (array)
. ano_base (integer)
. naomostradados_venda (boolean)
} (object) required
post_api_v1_relatorio_irpf_gerar_pdfrel_irpfv2Definição Técnica: 1. Autenticar o usuário cliente URI + /api/vversion/Autenticador/AutenticarUsuario 2. Seguir o modelo abaixo para preenchimento dos parâmetros de request para uso do método. - A ordem dos parâmetros 'Venda', 'Obra' e 'Empresa' é obrigatória. - Substituir cada parâmetro pelo valor correspondente: - 'Venda' - Número da Venda. - 'Obra' - Código da Obra. - 'Empresa' - Número da Empresa. - 'ano_base' - ano base para geração do IRPF.data: {
. vendasobras_empresa (array)
. ano_base (integer)
. naomostradados_venda (boolean)
} (object) required
post_api_v1_requisicao_compra_aprovar_requisicoes_compraDefinição Técnica: 1. Autenticar o usuário cliente URI + /api/vversion/Autenticador/AutenticarUsuario 2. Preencher os parâmetros de request para uso do método. Regras básicas: 1. É necessário permissão de aprovação para o programa ALREQUISICAOCOMPRAdata: {
. Requisicoes (array)
. Departamento (string)
. Cargo (string)
. CodJustificativa (integer)
. ObsJustificativa (string)
} (object) required
post_api_v1_requisicao_compra_desaprovar_requisicoes_compraDefinição Técnica: 1. Autenticar o usuário cliente URI + /api/vversion/Autenticador/AutenticarUsuario 2. Preencher os parâmetros de request para uso do método. Regras básicas: 1. É necessário permissão de aprovação para o programa ALREQUISICAOCOMPRA 2. Será permitido desaprovar apenas requisições de compra com estágio 0 - Criadadata: {
. Requisicoes (array)
. CodJustificativaDesaprovacao (integer)
. ObsJustificativaDesaprovacao (string)
} (object) required
post_api_v1_reserva_gravar_reservaDefinição técnica: 1. Preencher os parâmetros de request para uso do método. - As contrabarras são impotantes para não encerrar a string antes do fim. - As datas devem estar no formato: AAAA-MM-DD. - SE O VALOR A SER PASSADO É NULL OU VAZIO, NÃO O INFORME NO JSON. - Troque apenas os ❌ pelos valores desejados. - o JSON deve ser uma string no seguinte formato: 'dados_reserva_json': ' 'reserva':data: {
. dados_reserva_json (string)
} (object) required
post_api_v1_reserva_excluir_reservaDefinição Técnica: 1. Autenticar o usuário cliente URI + /api/vversion/Autenticador/AutenticarUsuario 2. Preencher os parâmetros de request para uso do método. Definição de Negócio: 1. Valida usuário e permissõesdata: {
. empresa (integer)
. obra (string)
. num_proposta (integer)
. cod_produto (integer)
. cod_person (integer)
. cod_reserva (integer)
} (object) required
post_api_v1_reserva_consultar_reservasDefinição Técnica: 1. Autenticar o usuário cliente URI + /api/vversion/Autenticador/AutenticarUsuario 2. Preencher os parâmetros de request para uso do endpoint. Definição de Negócio: 1. Consulta reservas da personalização que possuem o status informado na request.data: {
. empresa (integer)
. cod_produto (integer)
. cod_person (integer)
. status (string)
} (object) required
post_api_v1_reserva_consultar_reserva_vendedorDefinição Técnica: 1. Autenticar o usuário cliente URI + /api/vversion/Autenticador/AutenticarUsuario 2. Preencher os parâmetros de request para uso do endpoint Definição de Negócio: 1. Valida usuário e permissõesdata: {
. empresa (integer)
. num_prod (integer)
. num_per (integer)
. vendedor (integer)
} (object) required
post_api_v1_reserva_consultar_reserva_por_codigoDefinição Técnica: 1. Autenticar o usuário cliente URI + /api/vversion/Autenticador/AutenticarUsuario 2. Preencher os parâmetros de request para uso do endpoint. Definição de Negócio: 1. Consulta todas as reservas da personalização que tem o código informado. 2. Valida usuário e suas permissões.data: {
. empresa (integer)
. cod_produto (integer)
. cod_person (integer)
. cod_reserva (integer)
} (object) required
post_api_v1_reserva_consulta_reserva_por_propostaDefinição Técnica: 1. Autenticar o usuário cliente URI + /api/vversion/Autenticador/AutenticarUsuario 2. Preencher os parâmetros de request para uso do endpoint. Definição de Negócio: 1. Valida usuário e permissõesdata: {
. empresa (integer)
. obra (string)
. num_proposta (integer)
} (object) required
post_api_v1_reserva_consultar_dados_controle_reservaDefinição Técnica: 1. Autenticar o usuário cliente URI + /api/vversion/Autenticador/AutenticarUsuario 2. Preencher os parâmetros de request para uso do método. Definição de Negócio: 1. Valida usuário e permissões.data: {
. empresa (integer)
. cod_produto (integer)
. cod_person (integer)
. status (string)
} (object) required
post_api_v1_rotinas_gerais_busca_campos_personDefinição Técnica: 1. Autenticar o usuário cliente URI + /api/vversion/Autenticador/AutenticarUsuario 2. Preencher os parâmetros de request para uso do método. Definição de Negócio: 1. Consulta campos personalizados de empresa e produto. 2. Valida permissão de consulta 2 para o usuário autenticadodata: {
. empresa (string)
. produto (string)
} (object) required
post_api_v1_rotinas_gerais_busca_capvenda_empresaDefinição Técnica: 1. Autenticar o usuário cliente URI + /api/vversion/Autenticador/AutenticarUsuario 2. Preencher os parâmetros de request para uso do método. Definição de Negócio: 1. Irá retornar as configurações de CAPs de uma determinada empresa. 2. Existem dois estados para o request: 1. Caso o request seja nulo, irá retornar todas as configurações de CAPs existentes no sistema. 2. Caso seja determinado um número de empresa, irá retornar as configurações de CAPs dessa empredata: {
. CodigoEmpresa (integer)
} (object) required
post_api_v1_rotinas_gerais_inserir_consulta_geralDefinição Técnica: 1. Autenticar o usuário cliente URI + /api/vversion/Autenticador/AutenticarUsuario 2. Preencher os parâmetros de request para uso do método. A Globaltec não se responsabiliza: 1. Pela compatibilidade entre as alterações do banco de dados e as consultas personalizadas efetuadas pelos clientes. 2. Pelos dados informados nos geradores de resultado que utilizam consultas personalizadas criadas pelos clientes. Definição de Negócio: 1. Irá realizar a inserção da consultdata: {
. ClausulaSql (string)
. Descricao (string)
. CodigoPasta (string)
. Status (integer)
. Parametros (array)
} (object) required
post_api_v1_rotinas_gerais_executar_consulta_geralDefinição Técnica: 1. Autenticar o usuário cliente URI + /api/vversion/Autenticador/AutenticarUsuario 2. Preencher json do request com o devido Id e se é personalizado ou não 0 ou 1 sendo considerados como interno e externo respectivamente Definição de Negócio: 1. Consulta campos personalizados de empresa e produto. 2. Valida permissão de consulta 2 para o usuário autenticado 3. Os parâmetros de cada consulta geral podem ser consultados através da rota RotinasGerais/ConsultarParamConsuldata: {
. Id (integer)
. Personalizado (integer)
. Parameters (array)
} (object) required
post_api_v1_rotinas_gerais_buscar_indices_de_reajusteDefinição Técnica: 1. Autenticar o usuário cliente URI + /api/vversion/Autenticador/AutenticarUsuario 2. Preencher os parâmetros de request para uso do método. Definição de Negócio: 1. Busca a lista de índices de reajuste ativos do sistemaNo parameters
post_api_v1_rotinas_gerais_buscar_tipos_de_vencimentoDefinição Técnica: 1. Autenticar o usuário cliente URI + /api/vversion/Autenticador/AutenticarUsuario 2. Preencher os parâmetros de request para uso do método. Definição de Negócio: 1. Possibilita consultar os tipo de vencimento que estão ativos.No parameters
post_api_v1_rotinas_gerais_consultar_padroes_cobrancaDefinição Técnica: 1. Autenticar o usuário cliente URI + /api/vversion/Autenticador/AutenticarUsuario 2. Preencher os parâmetros de request para uso do método. Definição de Negócio: 1. O único campo obrigatório do request é o Status. 2. Irá retornar os padrões de cobrança de acordo com os filtros. 3. As informações personalizadas da cobrança virão como Configuracao_01 até a Configuracao_08.data: {
. Empresa (integer)
. Status (integer)
. Banco (integer)
} (object) required
post_api_v1_rotinas_gerais_buscar_categorias_de_produtoDefinição Técnica: 1. Autenticar o usuário cliente URI + /api/vversion/Autenticador/AutenticarUsuario 2. Preencher os parâmetros de request para uso do método. Definição de Negócio: 1. Consulta a lista de categorias de produtos com status ativos.No parameters
post_api_v1_rotinas_gerais_buscar_finalidades_de_compraDefinição Técnica: 1. Autenticar o usuário cliente URI + /api/vversion/Autenticador/AutenticarUsuario 2. Este endpoint não necessita de parâmetros no request. Definição de Negócio: 1. Consulta a lista de finalidades para compras com status ativo.No parameters
post_api_v1_rotinas_gerais_buscar_veiculos_de_divulgacaoreturnsLista de Veículos de divulgação./returns Definição Técnica: 1. Autenticar o usuário cliente URI + /api/vversion/Autenticador/AutenticarUsuario 2. Preencher os parâmetros de request para uso do método. Definição de Negócio: 1. Consulta veículos de divulgação que estão ativos.No parameters
post_api_v1_rotinas_gerais_consultar_param_consulta_geralDefinição Técnica: 1. Autenticar o usuário cliente URI + /api/vversion/Autenticador/AutenticarUsuario 2. Preencher json do request com o devido Id e se é personalizado ou não 0 ou 1 sendo considerados como interno e externo respectivamente 3. Retorna uma lista de parâmetros dinâmicos, apresentando o nome do parâmetro e sua descrição, se ele é restrito, multiseleção e OrigemDados com pressuposição do uso dessas informações em 'ExecutarConsultaGeral Definição de Negócio: 1. Permite visuadata: {
. Id (integer)
. Personalizado (integer)
} (object) required
post_api_v1_shopping_grava_rendimentosDefinição Técnica: 1. Autenticar o usuário cliente URI + /api/vversion/Autenticador/AutenticarUsuario 2. Preencher os parâmetros de request para uso do método.data: {
. dia (string)
. lojista (boolean)
. empresa (integer)
. obra (string)
. venda (integer)
. valor_lancamento (number)
. usuario (string)
. tipo_usuario (integer)
} (object) required
post_api_v1_shopping_importacao_de_parcelasDefinição Técnica: 1. Importação de parcelas a receber/recebida para vendas do tipo Aluguel Shopping: - URI + /api/vversion/Shopping/ImportacaoDeParcelas Definição de Negócio: 1. Permite importar parcelas a receber/recebida para vendas do tipo Aluguel Shopping com as seguintes regras: - Para importação de parcelas A RECEBER, os seguintes campos devem ser desconsiderados ou não preenchidos: ValorJurosContrato,ValorCorrecao,ValorMulta,ValorCorrecaoAtraso,ValorJurosAtraso,ValorDesconto,Vdata: {
. Parcelas (array)
} (object) required
post_api_v1_shopping_consultar_rendimento_lojistaMétodo que consulta para lançamentos de rendimento de lojista e auditor.data: {
. cod_empresa (integer)
. cod_obra (string)
. num_venda (integer)
. ini_lancamento (string)
. fim_lancamento (string)
} (object) required
post_api_v1_usuarios_consultar_usuarios_ativosSe não informar o parâmetro “login_usuario”, vai está retornando todos os usuários ativos disponíveis. Definição Técnica: 1. Autenticar o usuário cliente URI + /api/vversion/Autenticador/AutenticarUsuario 2. Preencher os parâmetros de request para uso do método. Parâmetros da request 1. login_usuario: Nome do login usuario.data: {
. login_usuario (string)
} (object) required
post_api_v1_usuarios_consultar_grupos_de_usuarioDefinição Técnica: 1. Autenticar o usuário cliente URI + /api/vversion/Autenticador/AutenticarUsuarioNo parameters
post_api_v1_venda_renegociar_vendaDefinição Técnica: 1. Autenticar o usuário cliente URI + /api/vversion/Autenticador/AutenticarUsuario 2. Preencher os parâmetros de request para uso do método Definição de Negócio: Permite renegociar parcelas de uma venda 1. O usuário deverá estar autenticado e validado 2. Informar os dados da venda 3. Informar as parcelas a serem geradas 4. Informar as parcelas escolhidas para renegociação 5. Informar o plano de indexação 6. Será realizada validação referente as informações preenchidata: {
. Empresa (integer)
. Obra (string)
. Venda (integer)
. Parc_Geradas (array)
. ParcSel_Reneg (array)
. ValDesc_reneg (number)
. ValAcresc_reneg (number)
. Valor_Reajustado (integer)
. NumeroPadraoCobranca (integer)
. Tabelaplano_idx (array)
. DataCalculo (string)
} (object) required
post_api_v1_venda_busca_parc_reneg_webDefinição Técnica: 1. Autenticar o usuário cliente URI + /api/vversion/Autenticador/AutenticarUsuario 2. Preencher os parâmetros de request para uso do método. Definição de Negócio: Possibilita buscar parcelas calculadas para a data atual dia da requisição.data: {
. empresa (integer)
. obra (string)
. num_ven (integer)
. exibirparcenv_cob (boolean)
. somenteparc_atraso (boolean)
. parcelasenviadas_banco (boolean)
} (object) required
post_api_v1_venda_exclusao_de_boletosDefinição Técnica: 1. Autenticar o usuário cliente URI + /api/vversion/Autenticador/AutenticarUsuario 2. Preencher os parâmetros de request para uso do método. Definição de Negócio: 1. Possibilita excluir boletos que estão com o status de normal. 2. Será permitido a exclusão de no máximo 20 boletos por requisição.data: {
. listaBoletosExcluir (array)
} (object) required
post_api_v1_venda_exportar_vendas_xmlDefinição Técnica: 1. Autenticar o usuário cliente URI + /api/vversion/Autenticador/AutenticarUsuario 2. Consultar os dados das contas contábeis com a URI + /api/vversion/Venda/ExportarVendasXml 3. Preencher os parâmetros de request para uso do método. Definição de Negócio: Permite exportar os registros de uma ou mais vendas do UAU para um arquivo XML no formato esperado para realização de importação de vendas. 1. Deve informar a venda ou o período para que seja realizada a consulta. 2.data: {
. dados_vendas (object)
} (object) required
post_api_v1_venda_importacao_de_vendaDefinição Técnica: 1. Autenticar o usuário cliente URI + /api/vversion/Autenticador/AutenticarUsuario 2. Preencher os parâmetros de request para uso do método. 3. Número máximo de importações por vez: 50. 4. Para obter retorno de sucesso ou falha na importação consulte o endpoint: - URI + /api/v1.0/Venda/ImportacaoVendaComRetorno Validação: 1. Arquivo XSD: https://ajuda.globaltec.com.br/wp-content/uploads/2021/01/Manual-de-integracao-de-Vendas_versao1006_2.zip 2. Dicionário de dadata: {
. xml_vendas (string)
. alterarnumerodas_vendas (boolean)
} (object) required
post_api_v1_venda_aprov_desaprov_renegDefinição técnica: - Autenticar o usuário cliente URI + /api/vversion/Autenticador/AutenticarUsuario Definição de negócio - A rota aprova ou desaprova uma renegociação de venda. - É realizada uma validação da Alçada. - Os anexos são atualizados conforme a operação solicitada. Pré requisito: - É necessário ter permissão de aprovação em FIMNTVENRENCON - Verifique o endpoint abaixo para obter informações dos parametros de entrada aceitos: - URL + /api/vversion/Venda/AprovDesaprovdata: {
. codEmpresa (integer)
. codObra (string)
. numVenda (integer)
. aprovDesaprov (boolean)
} (object) required
post_api_v1_venda_buscar_tipos_de_custasDefinição Técnica: 1. Busca a lista de status de cobrança ativos do sistema: - URI + /api/vversion/Venda/BuscarTiposDeCustas 1. Formato dos dados retornados: - CodigoString:Código do tipo de custa - DescricaoString:Descrição do status de cobrançaNo parameters
post_api_v1_venda_consultar_historicosDefinição Técnica: 1. Autenticar o usuário cliente URI + /api/vversion/Autenticador/AutenticarUsuario 2. Preencher os parâmetros de request para uso do método. 3. O preenchimento da lista de vendas, devem ser preenchidos de forma padronizada, ou preenche todas as vendas com o número da venda, ou todas com apenas empresa e obra. 4. Para o preenchimento dos tipos de manutenção, o valor de tipo de manutenção deve ser numérico e caso tenha mais de um, devem ser separados por vírgula. Exemplo: 1,data: {
. Vendas (array)
. DataInicio (string)
. DataFim (string)
. TipoManutencao (string)
} (object) required
post_api_v1_venda_excluir_parcela_custaReliza a exclusão de Parcela de Custa.data: {
. ExcluirParcelaNoBanco (boolean)
. Lista (array)
} (object) required
post_api_v1_venda_gerar_boleto_bancarioDefinição Técnica: 1. Autenticar o usuário cliente URI + /api/vversion/Autenticador/AutenticarUsuario 2. Preencher os parâmetros de request para uso do método. Definição de Negócio: 1. Permite gerar o boleto bancário ou carnê. 2. O usuário autenticado deve ter permissão de inclusão no programa de permissão VEBOLETOAVULSO. 3. Para gerar boleto parcial é necessário informar a propriedade ValorBoleto. - Não pode ser um valor negativo nem inferior a 0,01 centavo. - Se informar um vdata: {
. parcelas (array)
. data_calculo (string)
. antecipar (boolean)
. reajustar (boolean)
. excluirboleto_expirado (boolean)
. formaarquivo_cobranca (integer)
. boletosacado_detalhado (boolean)
. carnetres_vias (boolean)
. naovalidardados_pendentes (boolean)
. acrescentar_residuo (boolean)
. usarpadraoboleto_avulso (boolean)
. agrupar_parcelas (boolean)
. formaagruparpor_vendas (boolean)
. ValorBoleto (number)
. PadraoCobranca (integer)
. ExcluirBoletosExistentes (boolean)
. ReaproveitarBoleto (boolean)
. ValorTaxaBoleto (number)
} (object) required
post_api_v1_venda_gerar_pdfresumo_vendaDefinição Técnica: 1. Autenticar o usuário cliente URI + /api/vversion/Autenticador/AutenticarUsuario 2. Preencher os parâmetros de request para uso do método. 3. Para transformar a string de retorno em PDF utilize algo como: Base64 to PDF. Definição de Negócio: Gera boleto PDF do resumo da venda em formato Base64. 1. Validações a nível de usuário.data: {
. codigoEmpresa (integer)
. codigoObra (string)
. numeroVenda (integer)
. dataCalculo (string)
. dataCorrecao (string)
. antecipar (boolean)
. parcelas (array)
. aplicarDescontoGeral (boolean)
. percentualDescontoGeral (number)
. aplicarDescontoAntecipacao (boolean)
. descontoAntecipacao (object)
} (object) required
post_api_v1_venda_buscar_status_cobrancaDefinição Técnica: 1. Busca a lista de status de cobrança ativos do sistema: - URI + /api/vversion/Venda/BuscarStatusCobranca 1. Formato dos dados retornados: - CodigoInteger:Código do status de cobrança - DescricaoString:Descrição do status de cobrançaNo parameters
post_api_v1_venda_consultar_resumo_vendaDefinição Técnica: 1. Autenticar o usuário cliente URI + /api/vversion/Autenticador/AutenticarUsuario 2. Preencher os parâmetros de request para uso do método. Definição de Negócio: Obtêm informações referentes a venda consultada.data: {
. codigoEmpresa (integer)
. codigoObra (string)
. numeroVenda (integer)
. dataCalculo (string)
. dataCorrecao (string)
. antecipar (boolean)
. parcelas (array)
. aplicarDescontoGeral (boolean)
. percentualDescontoGeral (number)
. aplicarDescontoAntecipacao (boolean)
. descontoAntecipacao (object)
} (object) required
post_api_v1_venda_gerar_venda_de_propostaDefinição Técnica: 1. Autenticar o usuário cliente URI + /api/vversion/Autenticador/AutenticarUsuario 2. Preencher os parâmetros de request para uso do método. Definição de Negócio: Realiza venda de acordo com a proposta informada. 1. Validações serão realizadas para efetuar a operação. 2. Todas alterações informadas no request apenas afetarão a venda gerada. 3. A opção de desconsiderar não titulares avalistas, serve para o caso onde queriam gravar uma venda sem titular avalista, que podata: {
. numeroProposta (integer)
. atualizaDatasDaVenda (boolean)
. dataVenda (string)
. atualizaInicioPrimeiroJuros (boolean)
. atualizaInicioReajuste (boolean)
. atualizaInicioSegundoJuros (boolean)
. atualizaBaseResiduo (boolean)
. atualizaPlanoIndexador (boolean)
. dataPrimeiroJuros (string)
. dataSegundoJuros (string)
. dataReajuste (string)
. dataBaseResiduo (string)
. listaPlanoIndexador (array)
. desconsiderarNaoTitularesAvalista (boolean)
. diasProrrogacaoParcVencidas (integer)
. usuarioCadVenda (string)
. listaNaoTitularAvalista (array)
} (object) required
post_api_v1_venda_buscar_tipos_de_parcelasDefinição Técnica: 1. Busca a lista de status de cobrança ativos do sistema: - URI + /api/vversion/Venda/BuscarTiposDeParcelas 1. Formato dos dados retornados: - TipoString:Código do tipo de parcela - DescricaoString:Descrição do tipo de parcelaNo parameters
post_api_v1_venda_finalizar_renegociacaoDefinição Técnica: 1. Autenticar o usuário cliente URI + /api/vversion/Autenticador/AutenticarUsuario 2. Preencher os parâmetros de request para uso do método. Definição de Negócio: Possibilita finalizar determinada negociação.data: {
. usuario_logado (string)
. parc_geradas_json (string)
. parcsel_reneg_json (string)
. grupo_parcelas_json (string)
. valdesc_reneg (number)
. valacresc_reneg (number)
. val_reneg (number)
. pendentevalidar_alcada (boolean)
. venda (integer)
. obra (string)
. empresa (integer)
. tabelaplano_idx_json (string)
} (object) required
post_api_v1_venda_gravar_ocorrencia_anexoDefinição técnica: - Adiciona uma ou várias ocorrências vinculada de anexo de acordo com os parâmetros passados na requisição. Parâmetros da request 1. Chave: Chave para consulta. 2. Campos: - Campos obrigatórios para a chave='Venda' empresa, obra, venda, codigo ocorrencia, usuario. - Campos obrigatórios para a chave='Parcela' empresa, obra, venda, número parcela, número geral da parcela, tipo da parcela, codigo ocorrência, usuariodata: {
. Ocorrencias (array)
} (object) required
post_api_v1_venda_alterar_data_prorrogacaoNo description availabledata: {
. dados_prorrogacao (object)
} (object) required
post_api_v1_venda_buscar_parcelas_areceberDefinição Técnica: 1. Autenticar o usuário cliente URI + /api/vversion/Autenticador/AutenticarUsuario 2. Preencher os parâmetros de request para uso do método. Definição de Negócio: Possibilita a busca de parcelas a receber na data atual.data: {
. empresa (integer)
. obra (string)
. num_ven (integer)
. data_calculo (string)
. valor_presente (boolean)
} (object) required
post_api_v1_venda_buscar_parametro_cobrancaDefinição Técnica: 1. Busca a lista de parâmetros de cobrança ativos do sistema: - URI + /api/vversion/Venda/BuscarParametroCobranca 2. Formato dos dados retornados: - Banco String : Número do banco - NomeBanco String : Nome do banco - Conta String : Número da conta - Agencia String : Código da agência do banco - Carteira String : Código da carteira do convênio com banco - Codigo String : Código do parâmetro de cobrança no sistema - Descricao String : Descriçãodata: {
. empresa (integer)
. banco (integer)
} (object) required
post_api_v1_venda_buscar_parcelas_recebidasDefinição Técnica: 1. Autenticar o usuário cliente URI + /api/vversion/Autenticador/AutenticarUsuario 2. Preencher os parâmetros de request para uso do método. Definição de Negócio: Possibilita buscar parcelas que foram recebidas.data: {
. empresa (integer)
. obra (string)
. num_ven (integer)
} (object) required
post_api_v1_venda_buscar_status_de_escrituraDefinição Técnica: 1. Busca a lista de Status de escritura ativos do sistema: - URI + /api/vversion/Venda/BuscarStatusDeEscritura 1. Formato dos dados retornados: - CodigoInteger:Código de Status de escritura - DescricaoString:Descrição do Status de escrituraNo parameters
post_api_v1_venda_consultar_parcelas_da_vendaDefinição Técnica: 1. Autenticar o usuário cliente URI + /api/vversion/Autenticador/AutenticarUsuario 2. Preencher os parâmetros de request para uso do método. Definição de Negócio: Permite consultar as parcelas de uma venda. 1. Ao enviar somenteParcelasAptasBoleto como TRUE, irá validar se a venda possui bloqueio ou manutenção pendente e se a empresa está configurada para 'Não permitir enviar para banco parcelas com status em banco' - Caso a venda possua bloqueio ou esteja em manutdata: {
. empresa (integer)
. obra (string)
. num_venda (integer)
. data_calculo (string)
. boleto_antecipado (boolean)
. somenteParcelasAptasBoleto (boolean)
} (object) required
post_api_v1_venda_gerar_pdfevolucao_contratoDefinição Técnica: 1. Autenticar o usuário cliente URI + /api/vversion/Autenticador/AutenticarUsuario 2. Preencher os parâmetros de request para uso do método. 3. Para transformar a string de retorno em PDF utilize algo como: Base64 to PDF. Definição de Negócio: Gera PDF da evolução do contrato em string do tipo Base64. 1. Validações a nível de usuário.data: {
. codigoEmpresa (integer)
. codigoObra (string)
. numeroVenda (integer)
} (object) required
post_api_v1_venda_buscar_recebimentos_da_vendaDefinição Técnica: 1. Autenticar o usuário cliente URI + /api/vversion/Autenticador/AutenticarUsuario 2. Preencher os parâmetros de request para uso do método. Definição de Negócio: 1. Permite consultar os reecebimentos de uma venda, ou seja, o que já foi recebido. 2. Caso o campo 'parcelasnao_conciliadas' esteja marcado como 'true' as parcelas não conciliadas também serão retornadas.data: {
. empresa (integer)
. obra (string)
. venda (integer)
. parcelasnao_conciliadas (boolean)
} (object) required
post_api_v1_venda_exportar_pessoas_da_venda_xmlDefinição Técnica: 1. Autenticar o usuário cliente URI + /api/vversion/Autenticador/AutenticarUsuario 2. Preencher os parâmetros de request para uso do método. Definição de Negócio: Possibilita acesso às pessoas que estão relacionadas com a venda informada. 1. Valida a existência da venda.data: {
. lista_vendas (array)
} (object) required
post_api_v1_venda_gravar_pedido_de_recebimentoDefinição Técnica: 1. Autenticar o usuário cliente URI + /api/vversion/Autenticador/AutenticarUsuario 2. Preencher os parâmetros de request para uso do método. Definição de Negócio: 1. É obrigatório ter o ambiente de integração com a PAYGO configurado, só após o registro junto a eles que o registro será gerado no UAU. 2. É necessário ter permissão de inclusão no programa VEPEDIDORECEBIMENTOdata: {
. Empresa (integer)
. Obra (string)
. NumContrato (integer)
. Estabelecimento (string)
. FormaPgto (integer)
. QtdeParcelas (integer)
. DataCalculo (string)
. ValorLiquido (number)
. TipoRecebimento (integer)
. Antecipacao (boolean)
. Parcelas (array)
} (object) required
post_api_v1_venda_importacao_venda_com_retornoDefinição Técnica: 1. Autenticar o usuário cliente URI + /api/vversion/Autenticador/AutenticarUsuario 2. Preencher os parâmetros de request para uso do método. 3. Número máximo de importações por vez: 50. Definição de Negócio: Possibilita importa vendas via XML para o UAU e receber como retorno as vendas importadas. 1. Valida quantidade de importações por requisição. 2. Caso ocorra erro em uma venda, todas as outras importações são canceladas e terá um retorno com informações da venda qdata: {
. xml_vendas (string)
. alterarnumerodas_vendas (boolean)
} (object) required
post_api_v1_venda_manter_status_cobranca_vendaDefinição Técnica: 1. Autenticar o usuário cliente URI + /api/vversion/Autenticador/AutenticarUsuario 2. Preencher os parâmetros de request para uso do método. Definição de Negócio: Possibilita alterar o status de cobrança referentes a determinada venda. Validações serão realizadas para efetuar a operação: 1. Se os parâmetros forem da parcela, o ocorrência será gravada na parcela correspondente. 2. Se os parâmetros forem da venda, o ocorrência será gravada na venda correspondente. 3. Cdata: {
. empresa (integer)
. obra (string)
. venda (integer)
. numeroParcela (integer)
. numeroParcelaGeral (integer)
. tipoParcela (string)
. statusCobranca (array)
} (object) required
post_api_v1_venda_venda_valida_para_manutencaoDefinição Técnica: 1. Autenticar o usuário cliente URI + /api/vversion/Autenticador/AutenticarUsuario 2. Preencher os parâmetros de request para uso do método. Definição de Negócio: Valida a possibilidade de realizar a renegociação da venda, para tal tarefa a venda não pode ter restrições. 1. Os campos inseridos na request serão utilizado para buscar e verificar disponibilidade de renegociação.data: {
. empresa (integer)
. obra (string)
. venda (integer)
. usr_logado (string)
. mensagem_securitizacao (string)
} (object) required
post_api_v1_venda_consultar_contas_receber_calcDefinição Técnica: 1. Autenticar o usuário cliente URI + /api/vversion/Autenticador/AutenticarUsuario 2. Preencher os parâmetros de request para uso do método. Definição de Negócio: 1. Possibilita Consultar as parcelas de contas a receber já calculadas com retorno a lista de parcelas. 2. Nenhuma propriedade é obrigatória, porém é obrigatório ser enviado pelo menos um tipo de filtro para consultar os dados. 3. Na propriedade vendas, é obrigatório apenas o parâmetro empresa. 4. É indispendata: {
. DataInicio (string)
. DataFim (string)
. TiposParcela (string)
. Vendas (array)
} (object) required
post_api_v1_venda_importacao_parcelas_de_custasDefinição Técnica: 1. Importação de parcelas do tipo Custas: - URI + /api/vversion/Venda/ImportacaoParcelasDeCustas Definição de Negócio: 1. Permite importar parcelas do tipo Custas com as seguintes regras: - Os campos: Observacao, CobrarJurosAtraso, CobrarMulta, CobrarCorrecao, CobrarImposto, CobrarTxAdm, CobrarRepasseLocador, Competencia, NUMEROPARCELA e MeioPreferencialDeRecebimento são opcionais. 1. Referente a propriedade de CAPs: - Caso não sejam informados os CAPs para umadata: {
. custas (array)
} (object) required
post_api_v1_venda_buscar_campanha_desconto_vendaDefinição Técnica: 1. Autenticar o usuário através da rota: URI + /api/vversion/Autenticador/AutenticarUsuario 2. Preencher os parâmetros da requisição. Definição de Negócio: Permite consultar a campanha de desconto de antecipação vinculada a uma venda, retornando suas configurações para utilização em consultas e cálculos de desconto. Regras: 1. O usuário deve estar autenticado. 2. Informar os dados da venda para a qual deseja consultar a campanha. 3. Caso exista uma campanha dedata: {
. Empresa (integer)
. Obra (string)
. Venda (integer)
. DataCalculo (string)
} (object) required
post_api_v1_venda_cancelar_pedido_de_recebimentoDefinição Técnica: 1. Autenticar o usuário cliente URI + /api/vversion/Autenticador/AutenticarUsuario 2. Preencher os parâmetros de request para uso do método. Definição de Negócio: 1. Pedidos que já tiveram um recebimento parcial junto a NTK, não são cancelados. trava na NTK. 2. É necessário ter permissão de alteração no programa VEPEDIDORECEBIMENTOdata: {
. Empresa (integer)
. Obra (string)
. Pedido (integer)
} (object) required
post_api_v1_venda_atualizar_pedido_de_recebimentoDefinição Técnica: 1. Autenticar o usuário cliente URI + /api/vversion/Autenticador/AutenticarUsuario 2. Preencher os parâmetros de request para uso do método. Definição de Negócio: 1. Serão atualizadas as parcelas do pedido que ainda estão com status: 0 - Em aberto 2. Valida usuário e permissões 3. Valida outras informações passadas no requestdata: {
. Empresa (integer)
. Obra (string)
. Pedido (integer)
} (object) required
post_api_v1_venda_consultar_pedido_de_recebimentoDefinição Técnica: 1. Autenticar o usuário cliente URI + /api/vversion/Autenticador/AutenticarUsuario 2. Preencher os parâmetros de request para uso do método. Definição de Negócio: 1. Possibilita consultar pedido de recebimento junto a NTK 2. As informações retornadas serão informações do pedido na NTK. 3. É necessário ter permissão de consulta em VEPEDIDORECEBIMENTOdata: {
. Empresa (integer)
. Obra (string)
. Pedido (integer)
} (object) required
post_api_v1_venda_processar_recebimento_parcelasDefinição Técnica: 1. Autenticar o usuário cliente URI + /api/vversion/Autenticador/AutenticarUsuario 2. Preencher os parâmetros de request para uso do método. Definição de Negócio: Responsável por processar recebimentos de parcelas com os dados de recebimento e forma de pagamento. 1. A origem do recebimento das parcelas DEVE sempre ser 0. 2. Serão realizadas várias validações para realização da requisição. 3. O valor do desconto aplicado ao recebimento será sempre do objeto de recebimedata: {
. recebimento (object)
. formaPagamento (object)
} (object) required
post_api_v1_venda_manter_status_escrituracao_vendaDefinição Técnica: 1. Autenticar o usuário cliente URI + /api/vversion/Autenticador/AutenticarUsuario 2. Preencher os parâmetros de request para uso do método. Definição de Negócio: 1. Valida usuário e suas permissõesdata: {
. empresa (integer)
. obra (string)
. venda (integer)
. statusEscrituracao (array)
} (object) required
post_api_v1_venda_retorna_chaves_vendas_por_periodoDefinição Técnica: 1. Autenticar o usuário cliente URI + /api/vversion/Autenticador/AutenticarUsuario 2. Preencher os parâmetros de request para uso do método. 3. Formatação das chaves de resposta: 'Empresa-Obra/Venda, Empresa-Obra/Venda, Empresa-Obra/Venda' '01705-B1705/00159,01705-B1705/00160,01705-B1705/00161' Definição de Negócio: 1. Permite consultar as chaves das vendas que foram inseridas, tiveram manutenção ou foram quitadas no período informado. 2. Se o campdata: {
. data_inicio (string)
. data_fim (string)
. status_escrituracao (boolean)
. statusVenda (string)
. listaEmpresaObra (array)
} (object) required
post_api_v1_venda_consultar_demonstrativo_correcaoDefinição Técnica: 1. Autenticar o usuário cliente URI + /api/vversion/Autenticador/AutenticarUsuario 2. Preencher os parâmetros de request para uso do método. Definição de Negócio: Permite consultar demonstrativo de correção da parcela da venda. 1. Valida usuário e suas permissões. 2. Valida existência da venda. 3. Valida existência das parcelas.data: {
. empresa (integer)
. obra (string)
. venda (integer)
. numeroParcela (integer)
. numeroParcelaGeral (integer)
. tipoParcela (string)
. dataCalculo (string)
. dataCorrecao (string)
. valorAntecipado (boolean)
} (object) required
post_api_v1_venda_consultar_plano_indexadores_vendaDefinição Técnica: 1. Autenticar o usuário cliente URI + /api/vversion/Autenticador/AutenticarUsuario 2. Preencher os parâmetros de request para uso do método. Definição de Negócio: Retorna informações pertinentes ao plano indexador da venda.data: {
. empresa (integer)
. obra (string)
. venda (integer)
} (object) required
post_api_v1_venda_gravar_num_contrato_financiamentoDefinição técnica: - Altera número de contrato para uma venda. Pré requisito: - Verifique o endpoint abaixo para obter informações dos parametros de entrada aceitos: - URL + /api/vversion/Venda/GravarNumContratoFinanciamento Anexos: - Exemplo Postman: ALTERAR EXEMPLOdata: {
. codgEmpresa (integer)
. codgObra (string)
. numVenda (number)
. codgUsuario (string)
. numContrato (string)
} (object) required
post_api_v1_venda_consultar_empreendimentos_clienteDefinição Técnica: 1. Autenticar o usuário cliente URI + /api/vversion/Autenticador/AutenticarUsuario 2. Preencher os parâmetros de request para uso do método. Definição de Negócio: Consulta os empreendimento que o cliente possui e está com situação em aberto.data: {
. codigo_usuario (integer)
} (object) required
post_api_v1_venda_consultar_pedido_de_recebimento_uauDefinição Técnica: 1. Autenticar o usuário cliente URI + /api/vversion/Autenticador/AutenticarUsuario Definição de Negócio: 1. Possibilita consultar pedido de recebimento registrado no UAU por número do pedido junto a NTK ou pelo número do pedido no UAU. 2. As informações retornadas são referentes a como o UAU registrou o pedido internamente. 3. É necessário ter permissão de consulta em VEPEDIDORECEBIMENTOdata: {
. NumeroNTK (integer)
. NumeroPedido (integer)
} (object) required
post_api_v1_venda_consultar_unidades_compradas_por_cpfDefinição Técnica: 1. Autenticar o usuário cliente URI + /api/vversion/Autenticador/AutenticarUsuario Definição de Negócio: Possibilita consultar unidades que foram compradas por determinado CPF/CNPJ 1. Valida se o usuário está autenticado logado no sitema. 2. Verifica se o Cpf/Cnpj informado existe cadastrado no sistema.data: {
. CpfCnpj (string)
} (object) required
post_api_venda_consultar_status_cobranca_ativaNo description availablecodigo (string) required
api-version (string)
post_api_v1_venda_calcular_desconto_campanha_antecipacaoDefinição Técnica: 1. Autenticar o usuário através da rota: URI + /api/vversion/Autenticador/AutenticarUsuario 2. Preencher os parâmetros da requisição. Definição de Negócio: Permite calcular o desconto de campanha de antecipação para uma ou mais parcelas de uma venda. Regras: 1. O usuário deve estar autenticado. 2. A venda deve possuir uma campanha de desconto de antecipação vigente. 3. Os dados da campanha devem ser informados na requisição. Para obtê-los, utilize previamente adata: {
. CampanhaDeDesconto (object)
. ParcelasCalculadas (array)
. DataCalculo (string)
} (object) required
post_api_v1_venda_consultar_campanha_desconto_disponivelDefinição Técnica: 1. Autenticar o usuário cliente URI + /api/vversion/Autenticador/AutenticarUsuario 2. Preencher os parâmetros de request para uso do método. Definição de Negócio: Consulta a campanha de desconto disponível para utilização. 1. Valida usuário logado e permissõesdata: {
. codigoEmpresa (integer)
. codigoObra (string)
. numeroVenda (integer)
. dataCalculo (string)
. dataCorrecao (string)
} (object) required
post_api_v1_venda_consultar_desconto_antecipacao_parcelaDefinição Técnica: 1. Autenticar o usuário cliente URI + /api/vversion/Autenticador/AutenticarUsuario 2. Preencher os parâmetros de request para uso do método. Definição de negócio: Consulta o valor do desconto caso a parcela seja paga antecipadamente.data: {
. empresa (integer)
. obra (string)
. num_venda (integer)
. num_parc (integer)
. numparc_ger (integer)
. tipo_parc (string)
. data_calculo (string)
. valor_parcela (number)
. data_vencimento (string)
. data_prorrogacao (string)
. totalparcelas_sel (integer)
. antecipado (boolean)
. totalpara_quitacao (integer)
} (object) required
post_api_v1_venda_consultar_unidades_compradas_usr_logadoDefinição Técnica: 1. Autenticar o usuário cliente URI + /api/vversion/Autenticador/AutenticarUsuario Definição de Negócio: Possibilita consultar unidades que foram compradas por determinado usuário. 1. Valida se o usuário está autenticado logado no sitema. 2. Usuário só pode ser do tipo pessoa. 3. Valida se o usuário está cadastrado para acesso no UAUWeb.No parameters
post_api_v1_venda_consultar_unidades_compradas_por_cpfcnpjDefinição Técnica: 1. Autenticar o usuário cliente URI + /api/vversion/Autenticador/AutenticarUsuario Definição de Negócio: Possibilita consultar unidades que foram compradas por determinado CPF/CNPJ 1. Valida se o usuário está autenticado logado no sitema. 2. Verifica se o Cpf/Cnpj informado existe cadastrado no sistema.data: {
. CpfCnpj (string)
} (object) required
post_api_v1_venda_gerar_pdfevolucao_saldo_devedor_financiamentoDefinição Técnica: 1. Autenticar o usuário cliente URI + /api/vversion/Autenticador/AutenticarUsuario 2. Preencher os parâmetros de request para uso do método. 3. Para transformar a string de retorno em PDF utilize algo como: Base64 to PDF. Definição de Negócio: Gerar PDF do relatório de evolução do saldo devedor do financiamento imobiliário da venda em formato Base64.data: {
. codigoEmpresa (integer)
. codigoObra (string)
. numeroVenda (integer)
. tipoRelatorio (integer)
} (object) required
get_api_v1_webhook_confirmar_recebimento_ordem_compra_by_tokenAlteração : Alexandre Mendes Data: 19/09/2022 Projeto : 427564 - Sprint 5 - Engenhanria Manutenção: Alterado para extrair do token o tipo de resposta, sendo 1 = Aceito ou 3 = Recusado.token (string) required
post_api_v1_webhook_atualizar_recebimento_pixDefinição Técnica: Definição de Negócio:data: {
. endToEndId (string)
. txid (string)
. valor (string)
. horario (string)
. infoPagador (string)
. devolucoes (object)
. pagador (object)
} (object) required
post_api_v1_webhook_atualizar_pedido_recAtualizar o pedido de recebimento no UAU de acordo com o retorno da venda ou proposta de vendarecebimento pela maquininha de cartãorequest.cpfCnpj (string)
request.intencaoVendaId (string)
request.intencaoVendaReferencia (string)
request.pedidoId (string)
request.pedidoReferencia (string)
customCall any endpoint of the connected service while reusing the connection auth. Pass the full URL as _url. Other reserved keys: _method, _query, _body, _headers. Remaining params flow naturally — empty → GET, non-empty → POST JSON body._url (string) required
_method (string)
_query (object)
_body
_headers (object)