INTRODUÇÃO
Este web service tem por objetivo consultar os dados das vendas, importar e exportar vendas e etc. Assim, poderá consultar as parcelas recebidas, as unidades compradas, detalhes da venda e os empreendimentos do cliente.
LINK PARA ACESSO
//200.178.248.104:86/portaluautestes/Webservices/wsVenda.asmx
Obs.: O link irá variar de cliente para cliente, dependendo de onde o mesmo está hospedando seu Webservice, logo essa parte vermelha pode ser diferente.
AUTENTICAÇÃO
Todos serviços homologados para integração do UAU necessitam de autenticação de usuário UAU para a utilização do mesmo. Mais detalhes de como realizar a autenticação do usuário em: /integracao-uauweb-com-sites-de-clientes/#Servios_Web_para_Autenticao_de_Usurio
MÉTODOS
ExportarVendasXml
Busca as vendas informadas ou as vendas inseridas/alteradas no periodo informado.
Parâmetros
| Parâmetros | Tipo | Obrigatório | Descrição |
|---|---|---|---|
| dataInicio | Date | Não | Período inicial. |
| dataFim | Date | Não | Período final. |
| statusEscrituracao | boolean | Não | false - Não buscará as vendas que tiveram o status de escritura alterados. true - Irá buscar as vendas que tiveram o status de escritura alterados. |
| listaVendas | lista de ChavesVendas | Não | Lista com as chaves das vendas. |
ChaveVenda
| Parâmetros | Tipo | Obrigatório | Descrição |
|---|---|---|---|
| Venda | int | Sim | Número da venda |
| Obra | string | Sim | Código da obra |
| Empresa | int | Sim | Número da empresa |
Retorno
Venda
| Valor | Tipo | Obrigatório | Descrição |
|---|---|---|---|
| Empresa | Integer | Sim | Código da empresa |
| Obra | Varchar(8) | Sim | Código da obra |
| Numero | Integer | Sim | Número da venda |
| CodigoVendedor | Integer | Sim | Código do vendedor |
| CpfCnpjVendedor | Varchar(20) | Sim | CPF ou CNPJ do vendedor |
| PercentualJurosAtraso | Double | Sim | Percentual de juros por atraso |
| Multa | Double | Sim | Percentual de multa por atraso |
| Desconto | Double | Não | Valor de desconto concedido na venda |
| Usuario | Varchar(5) | Sim | Usuário de cadastro da venda |
| DataDaVenda | Date | Sim | Data de realização da venda |
| StatusVenda | Byte | Sim | Status da venda: 0 - Normal 1 - Cancelada 2 - Alterada 3 - Quitada 4 - EmAcerto |
| Acrescimo | Double | Não | Valor de acréscimo concedido na venda. |
| ContinuarCobrandoJurosContratualAoAtrasarParcela | Byte | Sim | Se irá continuar cobrando juros contratual ao atrasa as parcelas da venda: 0 - Não cobrar 1 - Cobrar |
| StatusEscritura | Integer | Não | Status da escritura |
| StatusCobranca | Integer | Não | Status da cobrança |
| PossuiReajusteAnual | Boolean | Sim | Indica se o cálculo do reajuste não será anual |
| GerarResiduo | Boolean | Sim | Indica se irá gerar resíduo no caso de calcular reajuste não mensal |
| CarenciaAtraso | Integer | SIM | Número de dias de carência para cobrança de juros e multa por atraso |
| QuantidadeMesesRetroagirCorrecao | Integer | Não | Número de meses que irá retroagir a data de reajuste |
| DataBaseResiduo | Date | Sim | Data base para geração das parcelas de resíduo |
| PossuiCorrecaoPorAtraso | Boolean | Sim | Indica se irá cobrar correção por atraso |
| PossuiCorrecaoProRata | Boolean | Sim | Indica se o cálculo da correção será pró-rata |
| DataCancelamento | Date | Não | Data de cancelamento da venda |
| CodigoDeDivulgaca o | Integer | Não | Código do meio de divulgação que originou a venda |
| CodigoFinalidade | Integer | Não | Código da finalidade da compra que originou a venda |
| CobrarTaxaDeBoleto | Byte | Sim | Indica se irá cobrar taxa de boleto para os boletos emitidos para a venda: 0 - Não cobrar 1 - Cobrar |
| DataDeCadastro | Date | Sim | Data de cadastro da venda |
| TipoDeVenda | Byte | Sim | Código do tipo da venda: 0 - Venda 1 - Aluguel 2 - Aluguel Garantido 3 - Transação financeira 4 - Revenda 5 - Aluguel shopping |
| AluguelShopping | Objeto | Não | Objeto com os dados do aluguel shopping |
| DiaDoRepasse | Integer | Sim | Define o dia do mês que será repassado o valor de aluguel para o(s) proprietário(s) |
| ValorProvisaoCurto | Double | Não | Valor de provisionamento de curto prazo |
| ValorProvisaoLongo | Double | Não | Valor de provisionamento de longo prazo |
| CapProvisaoCurto | Varchar(30) | Sim | CAP do valor de provisionamento de curto prazo |
| CapProvisaoLongo | Varchar(30) | Sim | CAP do valor de provisionamento de longo prazo |
| DiasCarenciaCorrecaoPorAtraso | Integer | Não | Número de dias de carência para cobrança de juros e multa por atraso |
| AnteciparCorrecao | Boolean | Sim | Indica se será cobrado correção diária ao realizar antecipação das parcelas da venda |
| CobrarJurosPosChave | Byte | Sim | Indica se uma parcela, cujo vencimento seja anterior ao início de juros, caso seja recebido após a data de início de juros, irá cobrar juros: 0 - Não cobrar 1 - Cobrar |
| DataInicioContrato | Date | Sim | Data do início do contrato de venda ou aluguel |
| DataFimContrato | Date | Sim | Data do fim do contrato de venda ou aluguel |
| TipoDeFianca | Byte | Sim | Código que define o tipo da fiança da venda: 0 - Sem fiança 1 - Fiadores 2 - Fiança bancária 3 - Caução 4 - Seguro fiança locaticia 5 - Carta fiança 6 - Título de captalização 7 - Imóvel em garantia |
| DadosDaFianca1 | Varchar | Não | Informação do tipo de fiança da venda |
| DadosDaFianca2 | Varchar | Não | Informação do tipo de fiança da venda |
| DadosDaFianca3 | Varchar | Não | Informação do tipo de fiança da venda |
| DataDaFianca | Date | Não | Data da fiança. Seu contexto varia de acordo com o tipo da fiança |
| ValorDaFianca | Double | Não | Valor da fiança. Seu contexto varia de acordo com o tipo da fiança |
| NomeSeguroIncendio | Varchar(150) | Não | Nome da seguradora responsável pelo seguro contra incêndio |
| ApoliceSeguroIncendio | Varchar(50) | Não | Número da apólice do seguro contra incêndio |
| ValorSeguroIncendio | Double | Não | Valor da apólice do seguro contra incêndio |
| DataVencimentoSeguroIncendio | Date | Não | Data do vencimento do seguro contra incêndio |
| CobrarMultaFracionada | Byte | Sim | Indica se a multa cobrada em caso de atraso da parcela será cobrada fracionada por dia: 0 - Não cobrar 1 - Cobrar |
| AnteciparJurosLinear | Boolean | Sim | Indica se a antecipação das parcelas com juros simples será realizada de forma linear |
| ValorDescontoImposto | Double | Sim | Valor total de imposto lançado na venda |
| PeriodoDeReajuste | Byte | Sim | Indica a periodicidade de reajuste nos casos de correção não mensal: 6 - semestral 12 - Anual |
| HistoricoLancamentoContabilVenda | Varchar(500) | Não | Histórico de lançamento contábil da venda |
| HistoricoLancamentoContabilParcela | Varchar(500) | Não | Histórico de lançamento contábil das parcelas da venda |
| HistoricoLancamentoContabilJurosCorrecao | Varchar(500) | Não | Histórico de lançamento contábil dos juros e correções da venda |
| ZerarCorrecaoNegativa | Boolean | Sim | Indica se irá zerar o valor de correção da parcela nos casos que o valor líquido da mesma seja inferior ao valor principal |
| CobrarJurosPorAtrasoMensal | Byte | Sim | Indica se o cálculo de juros por atraso será realizado de forma mensal ou pró-rata: 0 - Não cobrar 1 - Cobrar |
| CorrecaoCrescente | Boolean | Sim | Indica se irá congelar o valor de correção da parcela caso o índice de correção da mesma possua deflação entre o mês anterior e o atual |
| EnviarSpedPisCofins | Boolean | SIM | Indica se a venda ou aluguel será enviado para o SPED PIS/CONFINS |
| ContratoCaixaEconomicaFederal | Varchar(20) | Não | Número do contrato de financiamento associativo da venda na Caixa Econômica Federal |
| Atividade | Integer | Sim | Código do tipo de atividade da venda: 0 - Atividade imobiliária 1 - Prestação de serviço 2 - Ativo imobilizado 3 - Locação de equipamentos |
| ValorProvisaoCurtoBaixa | Double | Não | Valor de provisionamento de curto prazo no momento da quitação/cancelamento da venda |
| ValorProvisaoLongoBaixa | Double | Não | Valor de provisionamento de longo prazo no momento da quitação/cancelamento da venda |
| ValorProvisaoCurtoCessao | Double | Sim | Valor de provisionamento de curto prazo no momento da realização de cessão de direito da venda |
| ValorProvisaoLongoCessao | Double | Sim | Valor de provisionamento de longo prazo no momento da realização de cessão de direito da venda |
| CapProvisaoCurtoBaixa | Varchar(30) | Não | CAP do valor de provisionamento de curto prazo no momento da quitação/cancelamento da venda |
| CapProvisaoLongoBaixa | Varchar(30) | Não | CAP do valor de provisionamento de longo prazo no momento da quitação/cancelamento da venda |
| HistoricoLancamentoBaixaProvisao | Varchar(500) | Não | Histórico de lançamento contábil do provisionamento no momento da quitação/cancelamento da venda |
| CobrarCorrecaoMaisProrataMesRecebimento | Byte | SIM | Indica se deverá cobrar correção mais pró-rata no mês de recebimento da parcela da venda: 0 - Não cobrar 1 - Cobrar |
| CobrarJurosAnual | Byte | Sim | Indica se o cálculo de juros contratual da venda será mensal: 0 - Não cobrar 1 - Cobrar |
| PeriodoCobrancaDeJuros | Bytes | Sim | Indica a periodicidade de reajuste nos casos de correção não mensal: 6 - semestral 12 - Anual |
| ValorPrestacaoDeServicos | Double | Não | Valor de prestação de serviço da venda |
| AnteciparCorrecaoProximoPeriodo | Boolean | Sim | Indica se o cálculo de correção ao antecipar as parcelas da venda será realizado apenas no próximo período da venda de acordo com a data de cálculo |
| UtilizarDescontoUltimaParcela | Boolean | Sim | Indica se a venda participa da campanha de desconto total da última parcela. |
| VendaVinculada | Objeto | Não | Objeto com os dados da venda vinculada |
| Clientes | Objeto | Sim | Objeto com os dados do cliente |
| Itens | Objeto | Sim | Objeto com os dados do item da venda |
| Parcelas | Objeto | Sim | Objeto com os dados das parcelas |
| Impostos | Objeto | Sim | Objeto com os dados do imposto |
| Comissoes | Objeto | Não | Objeto com os dados da comissão |
| Seguros | Objeto | Não | Objeto com os dados do seguro |
| PlanosIndexadores | Objeto | Não | Objeto com os dados do plano indexador |
| Comentarios | Objeto | Não | Objeto com os dados do comentario |
Aluguel shopping
| Valor | Tipo | Obrigatório | Descrição |
|---|---|---|---|
| CodigoAtividade | Varchar(10) | Não | Código da atividade de shopping |
| TipoDeContrato | Varchar(1) | Não | Tipo do contrato: 0 - Normal 1 - Exceção 2 - CTO |
| BaseAluguelPercentual | Varchar(1) | Não | Base do aluguel: 0 - Aluguel mensal mínimo 1 - Aluguel apurado |
| Area | Double | Não | Área da loja |
| Frente | Double | Não | Frente da loja |
| Profundidade | Double | Não | Profundidade da Loja |
| CodigoLocalizacao | Integer | Não | Código da localização da loja. |
| PercentualAluguel | Double | Não | Percentual do aluguel complementar/aluguel percentual. |
| TipoDeReceita | Varchar(1) | Não | Tipo da receita informada: 0 - Receita bruta 1 - Receita liquida |
| ValorBaseFPP | Integer | Não | Valor percentual do fundo de promoção. |
Venda vinculada
| Valor | Tipo | Obrigatório | Descrição |
|---|---|---|---|
| Empresa | Integer | Sim | Código da empresa |
| Obra | Varchar(5) | Sim | Código da obra |
| Numero | Integer | Sim | Número da venda vinculada |
| UsuarioDeCadastro | Varchar(8) | Sim | Usuário que realizou o vínculo com a venda vinculada |
| DataDeCadastro | Data | Sim | Data de cadastro do vínculo com a venda vinculada |
Cliente
| Valor | Tipo | Obrigatório | Descrição |
|---|---|---|---|
| CodigoCliente | Integer | Sim | Código do cliente vinculado à venda |
| CpfCnpjDoCliente | Varchar(20) | Sim | Número do CPF ou CNPJ do cliente |
| EmitirBoleto | Boolean | Sim | Indica se os boletos emitidos para venda serão em nome do cliente |
| PercentualDoTitular | Double | Não | Percentual da venda correspondente aos titulares da venda |
| TipoDeCliente | Varchar(1) | Sim | Código que define o tipo de vínculo do cliente com o contrato de venda/aluguel: 0 - Titular 1 - Não titular 2 - Avalista |
| Principal | Boolean | Sim | Cliente é principal . |
Itens
| Valor | Tipo | Obrigatório | Descrição |
|---|---|---|---|
| CodigoProduto | Integer | Sim | Código do produto vendido |
| CodigoPersonalizacao | Integer | Sim | Código da personalização do produto vendido |
| Preco | Double | Sim | Preço unitário da personalização/produto vendido |
| Quantidade | Double | Sim | Quantidade vendida da personalização/produto |
| Contrato | Integer | Sim | |
| ValorComissaoDireta | Double | Sim | Valor de comissão direta da personalização/produto vendido |
| PercentualComissao | Double | Sim | Percentual de comissão cobrado no valor da personalização/produto vendido |
| NumeroItem | Varchar(50) | Sim | Numero item |
Parcelas
| Valor | Tipo | Obrigatorio | Descrição |
|---|---|---|---|
| NumeroParcela | Integer | Sim | Número da parcela |
| NumeroParcelaGeral | Integer | Sim | Numeração única da parcela dentro da venda |
| ParcelaRecebida | Boolean | Não | Indica se a parcela já foi recebida |
| OrigemParcela | Integer | Sim | Origem desta Parcela |
| TotalParcelasDoGrupo | Integer | Não | Quantidade de parcelas do grupo da parcela |
| TotalParcelasDoGrupoInformado | Integer | Sim | Quantidade de parcelas do grupo da parcela |
| TipoParcela | Varchar(3) | Sim | Código do tipo da parcela |
| DataRecebimento | Date | Não | Data de recebimento da parcela |
| DataCalculoReajuste | Date | Não | Data de inicio de reajuste da parcela |
| ValorPrincipal | Double | Sim | Valor principal da parcela |
| ValorResiduo | Double | Sim | Valor de resíduo gerado para a parcela |
| DataVencimento | Date | Sim | Data de vencimento da parcela |
| DataPrimeiraParcelaGrupo | Date | Não | Data de vencimento da primeira parcela do grupo da parcela |
| DataProrrogacao | Date | Não | Data de prorrogação da parcela |
| Amortizacao | byte | Sim | Código do tipo de amortização de juros utilizado na parcela: 0 - Gradiente 1 - Price 2 - SAC 3 - Simples |
| BeginEndPrice | byte | Sim | Indica se irá utilizar referência Begin ou End quando utilizar o tipo de amortização Price: 0 - Begin 1 - End |
| FrequenciaVencimento | Varchar(5) | Sim | Freqüência do vencimento |
| DataInicioPrimeiroJuros | Date | Sim | Data de início da cobrança do primeiro juros da parcela |
| TaxaPrimeiroJuros | Double | Não | Taxa do primeiro juros. |
| DataInicioSegundoJuros | Date | Não | Data de início da cobrança do segundo juros da parcela |
| TaxaSegundoJuros | Double | Não | Taxa do segundo juros da parcela |
| DataInicioReajuste | Date | Sim | Data de inicio de reajuste da parcela |
| IndiceReajuste | Varchar(5) | Sim | Código do índice de reajuste contido no grupo do plano indexado vinculado à venda |
| GrupoPlanoIndexador | Integer | Sim | Código do grupo de plano indexador utilizado na parcela |
| CobrarJurosPrimeiroPeriodo | Byte | Sim | Cobrar juros Primeiro período: 0 - Não cobrar 1 - Cobrar |
| DiasCarenciaMultaJurosAtraso | Integer | Não | Dias de carência para cobrar juros e multas. |
| DiasCarenciaCorrecaoAtraso | Integer | Não | Dias de carência para realizar correção por atraso. |
| CobrarJurosProRata | Byte | Sim | Cobrar Juros pro - rata: 0 - Não cobrar 1 - Cobrar |
| CobrarJurosProRataPrimeiroMes | Byte | Sim | Cobrar juros pro - rata primeiro mês: 0 - Não cobrar 1 - Cobrar |
| CapPrincipal | Varchar(30) | Sim | CAP do valor do principal da parcela |
| CapAcrescimo | Varchar(30) | Sim | CAP do valor de acréscimo da parcela |
| CapCorrecao | Varchar(30) | Sim | CAP do valor de correção da parcela |
| CapCorrecaoAtraso | Varchar(30) | Sim | CAP do valor de correção por atraso da parcela |
| CapDesconto | Varchar(30) | Sim | CAP do valor de desconto da parcela |
| CapDescontoAntecipacao | Varchar(30) | Sim | CAP do valor de desconto de antecipação da parcela |
| CapDescontoCondicional | Varchar(30) | Sim | CAP do valor de desconto condicional da parcela |
| CapDescontoCusta | Varchar(30) | Sim | CAP do valor de desconto de custa da parcela |
| CapJuros | Varchar(30) | Sim | CAP do valor de juros da parcela |
| CapJurosAtraso | Varchar(30) | Sim | CAP do valor de juros por atraso da parcela |
| CapMulta | Varchar(30) | Sim | CAP do valor de multa da parcela |
| CapRepasse | Varchar(30) | Sim | CAP do valor de repasse da parcela |
| CapTaxaBoleto | Varchar(30) | Sim | CAP do valor de taxa de boleto da parcel |
| TipoDaCusta | Integer | Sim | |
| OrigemCusta | Byte | Sim | Origem da custa: 0 - Obra 1 - Administração |
| CobrarMultaCusta | Byte | Sim | Cobrar Multa da custa: 0 - Não cobrar 1 - Cobrar |
| CobrarJurosAtrasoCusta | Byte | Sim | Cobrar Juros por Atraso de custa: 0 - Não cobrar 1 - Cobrar |
| CobrarTaxaAdministracaoCusta | Byte | Sim | Cobrar taxa de administração de custa: 0 - Não cobrar 1 - Cobrar |
| CobrarImpostoCusta | Byte | Sim | Cobrar Imposto de custa: 0 - Não cobrar 1 - Cobrar |
| CobrarCorrecaoCusta | Byte | Sim | Cobrar Correção de custa: 0 - Não cobrar 1 - Cobrar |
| RepassarValorLocadorCusta | Byte | Sim | Se irá repassar o valor do lançamento para o locador. Ela será utilizada para as parcelas do tipo custas as demais parcelas não utilizará esse campo. 0 - Não repassar 1 - Repassar |
| ObservacaoCusta | Varchar(4000) | Não | Observação de custa |
| PadraoCobranca | Integer | Sim | Código do padrão de cobrança |
| TipoSeguro | Byte | Sim | Código do tipo de seguro da parcela. 0 - MIP 1 - DFI |
| DescontosDeCusta | Double | Sim | Valor de desconto depositado atribuído em uma parcela através de um lançamento de custas. |
| DescontosDeImposto | Double | Sim | Valor de desconto atribuido em uma parcela através de um lançamento de imposto. |
| DadosDescontoCondicional | Double | Nao | Desconto condicional da parcela recebida |
| ValorDescontoCondicional | Double | Não | Valor do desconto condicional da parcela recebida |
| ValorDescontoCondicionalConfirmado | Double | Não | Valor confirmado de desconto da parcela recebida |
| ValorPrincipalConfirmado | Double | Não | Valor confirmado de principal da parcela recebida |
| ValorAcrescimo | Double | Não | Valor não confirmado de acréscimo da parcela recebida |
| ValorAcrescimoConfirmado | Double | Não | Valor confirmado de acréscimo da parcela recebida |
| ValorDesconto | Double | Não | Valor não confirmado de desconto condicional da parcela recebida |
| ValorDescontoConfirmado | Double | Não | Valor confirmado de desconto da parcela recebida |
| ValorCorrecaoAtraso | Double | Não | Valor não confirmado de correção por atraso da parcela recebida |
| ValorCorrecaoAtrasoConfirmado | Double | Não | Valor confirmado de correção por atraso da parcela recebida |
| ValorCorrecaoEmbutida | Double | Não | Valor não confirmado de correção embutido da parcela recebida |
| ValorCorrecaoEmbutidaConfirmado | Double | Não | Valor confirmado de correção embutido da parcela recebida |
| ValorJurosAtraso | Double | Não | Valor não confirmado de juros por atraso da parcela recebida |
| ValorJurosAtrasoConfirmado | Double | Não | Valor confirmado de juros por atraso da parcela recebida |
| ValorJurosContrato | Double | Não | Valor não confirmado de juros contratual da parcela recebida |
| ValorJurosContratoConfirmadoValorJurosContratoEmbutido | Double | Não | Valor confirmado de juros contratual embutido da parcela recebida |
| ValorJurosContratoEmbutidoConfirmado | Double | Não | Valor não confirmado de juros contratual embutido da parcela recebida |
| ValorMulta | Double | Não | Valor não confirmado de multa por atraso da parcela recebida |
| ValorMultaConfirmado | Double | Não | Valor confirmado de multa por atraso da parcela recebida |
| ValorCorrecao | Double | Não | Valor não confirmado de correção da parcela recebida |
| ValorCorrecaoConfirmado | Double | Não | Valor de correção confirmado |
| ValorDescontoAdiantamento | Double | Não | Valor desconto adiantamento |
| ValorDescontoAdiantamentoConfirmado | Double | Não | Valor confirmado de desconto da parcela recebida |
| Recebimentos | Vachar | Não | Informações sobre o recebimento |
| Prorrogacoes | Vachar | Não | Informações sobre prorrogações. |
| UsuarioRecebeu | Varchar(8) | Não | Usuário que recebeu a parcela |
| UsuarioCedeuDesconto | Varchar(8) | Não | Usuário que cedeu desconto na parcela a receber |
| DataInicioPeriodoAluguel | Date | Não | Date de incio do período de aluguel |
| GrupoDescontoPontuacao | Integer | Não | Grupo do recebimento de desconto total da ultima parcela. |
| RecebimentoPontuacao | Integer | Não | Como foi o recebimento da parcela. 0 - Em dia 1 - Em atraso 2 - Desconto total |
Impostos
| Valor | Tipo | Obrigatório | Descrição |
|---|---|---|---|
| Codigo | Varchar(5) | Sim | Código do imposto vinculado à venda |
| CAP | Varchar(30) | SIM | CAP do imposto vinculado à venda |
| ValorBase | Double | Sim | Valor base de incidência da alíquota do imposto |
| Aliquota | Double | Sim | Percentual da alíquota do imposto |
| HistoricoLancamentoContabil | Varchar(500) | Não | Histórico de lançamento contábil da venda |
Comissões
| Valor | Tipo | Obrigatório | Descrição |
|---|---|---|---|
| NumeroComissao | Integer | Sim | Número de comissão |
| CodigoPessoa | Intege | Sim | Código do corretor do controle de comissão vinculado à venda |
| CodigoDoCargo | Varchar(5) | Não | Código do cargo do corretor na estrutura de comissão utilizado no cadastro da venda |
| CpfCnpjDaPessoa | Varchar(20) | Não | CNPJ ou CPF do corretor do controle de comissão vinculado à venda |
| ValorDaComissao | Double | Sim | Valor do controle de comissão |
| DataPagamento | Date | Não | Data de pagamento do controle de comissão |
| PorcentagemVenda | Double | Não | Percentual de recebimento da venda necessário para liberação do controle de comissão |
| StatusComissao | Varchar(1) | Sim | Código do status do controle de comissão: 0 - Não liberado 1 - Liberado 2 - Pago 3 - Cancelado |
| GerarProcessoDePagamento | Varchar(1) | Sim | Indica se o pagamento do controle de comissão poderá ser realizado através de um processo de pagamento: 0 - Gerar processo 1 - Não gerar processo |
| TipoDePagamento | Varchar(1) | Sim | Código do tipo de pagamento: 0 - Direto 1 - Indireto |
| DataLiberacaoDaComissao | Date | Não | Data de liberação do controle de comissão |
| UsuarioRealizouPagamento | Varchar(8) | Não | Usuário que realizou o pagamento do controle de comissão |
| UsuarioCancelouComissao | Varchar(8) | Não | Usuário que realizou o cancelamento do controle de comissão |
| DataCancelamentoDaComissao | Date | Não | Data que foi realizado o cancelamento do controle de comissão |
| ObservacoesCancelamento | Varchar(255) | Não | Observação informada referente ao cancelamento do controle de comissão |
| DataAcrescimoDaComissao | Date | Sim | Data que foi realizado acréscimo no valor do controle de comissão |
| UsuarioAcrescimo | Varchar(8) | Não | Usuário que realizou o acréscimo no valor do controle de comissão |
| ValorAcrescimo | Double | Sim | Valor do acréscimo do controle de comissão |
| DataDescontoDoComissao | Date | Não | Data que foi realizado desconto no valor do controle de comissão |
| UsuarioDesconto | Varchar(8) | Não | Usuário que realizou o desconto no valor do controle de comissão |
| ValorDesconto | Double | Sim | Valor do desconto do controle de comissão |
| TipoDeLancamento | Varchar(1) | Tipo de lançamento: 0 - Comissão 1 - Bonificação | |
| NumeroRecibo | Integer | Não | |
| UsuarioLiberacao | Varchar(8) | Não | |
| EmpresaPagamento | Integer | Não | Empresa de pagamento |
| BancoPagamento | Integer | Não | Banco de pagamento |
| ContaPagamento | Varchar(20) | Não | Conta de pagamento |
| DataPrevistaPagamento | Date | Não | Data prevista para o pagamento da comissão |
Seguros
| Valor | Tipo | Obrigatório | Descrição |
|---|---|---|---|
| TipoDeSeguro | Varchar(1) | Sim | Tipo do seguro vinculado à venda: 0 - MIP 1 - DFI |
| TipoDoValorDoSeguro | Boolean | Sim | Indica se o valor do seguro será calculado por uma taxa percentual sobre o valor da venda ou por um valor fixo: 0 - Por taxa percentual 1 - Por valor fixo |
| ValorSeguro | Double | Sim | Valor do seguro a ser cobrado (percentual ou valor fixo) |
| UsuarioDeCadastro | Varchar(8) | Sim | Usuário que cadastrou o seguro na venda |
| DataDeCadastro | Data | SIM | Data de cadastro do vínculo com a venda vinculada |
| Cap | Varchar(30) | Sim | CAP de seguro vinculado à venda |
Plano indexador
| Valor | Tipo | Obrigatório | Descrição |
|---|---|---|---|
| Grupo | Integer | Sim | Número do grupo do plano indexador vinculado à venda |
| IndiceReajuste | Varchar(5) | Sim | Código do índice de reajuste contido no grupo do plano indexado vinculado à venda |
| Data | Date | Sim | Data de início de correção do índice dentro do grupo do plano indexador vinculado à venda |
Comentários
| Parâmentro | Tipo | Obrigatório | Descrição |
|---|---|---|---|
| codPessoa | Integer | Sim | Código do cliente. |
| naoMostraBoletoVencido | Boolean | Sim | True - Mostra os boletos cuja data de vencimento seja maior ou igual a data atual. False - Mostra todos os boletos |
| usuario | String | Sim | Login do usuário |
| tipoUsuario | Byte | Sim | Tipo do usuário 0 = usuário UAU 1 = usuário cliente |
| empresa | Integer | Sim | Código da empresa. |
| obra | String | Sim | Código da obra. |
| venda | Long | Sim | Número da venda. |
Método BuscarParcelasAReceber
Busca as parcelas a receber calculadas para a data atual.
Parâmetros
| Parâmetros | Tipo | Obrigatório | Descrição |
|---|---|---|---|
| Empresa | Int | Sim | Código da empresa |
| Obra | Varchar(5) | Sim | Código da obra |
| NumVen | Int | Sim | Número da venda |
| DataCalculo | Date | Sim | Data para cálculo das parcelas. |
| ValorPresente | Boolean | Sim | Indica se é para calcular as parcelas até o valor presente. (antecipar) |
Retorno
| Valor | Descrição |
|---|---|
| DataTable | Objeto com as informações das parcelas a receber. |
Dicionário de dados
| Campo | Tipo | Obrigatório | Descrição |
|---|---|---|---|
| Empresa_prc | Int | Sim | Código da empresa |
| Obra_Prc | String | Sim | Código da obra |
| NumVend_prc | Int | Sim | Número da venda |
| NumParc_Prc | Int | Sim | Número da parcela |
| NumParcGer_Prc | Int | Sim | Numeração única da parcela dentro da venda |
| Data_Prc | Date | Sim | Data de vencimento da parcela |
| Valor_Prc | Double | Sim | Valor principal da parcela |
| Status_Prc | Int | Sim | |
| Tipo_Prc | String | Sim | Código do tipo da parcela |
| Empresa_rea | Int | Não | |
| EmBancoPrc | Int | Sim | |
| Origem_Prc | Int | Sim | Número da parcela de origem |
| Cliente_Prc | int | Sim | Código do cliente vinculado à venda |
| DataPror_Prc | Date | Não | Data de prorrogação da parcela |
| JurosParc_prc | Double | Não | Taxa de juros |
| ComoParc_prc | String | Sim | Frequência de vencimento utilizada na parcela |
| IdxReaj_Prc | String | Sim | Código do índice de reajuste contido no grupo do plano indexado vinculado à venda |
| AmortParc_prc | byte | Sim | Código do tipo de amortização de juros utilizado na parcela: 0 - Gradiente 1 - Price 2 - SAC 3 - Simples |
| BegEndParc_prc | byte | Sim | Indica se irá utilizar referência Begin ou End quando utilizar o tipo de amortização Price: 0 - Begin 1 - End |
| DtIdxParc_prc | Date | Sim | Data de inicio de reajuste da parcela |
| DtJurosParc_prc | Date | Sim | Data de início da cobrança do primeiro juros da parcela |
| Cap_Prc | String | Sim | CAP do valor do principal da parcela |
| TotParc_prc | Integer | Não | Quantidade de parcelas do grupo da parcela |
| valorResiduo_prc | Double | Sim | Valor de resíduo gerado para a parcela |
| GrupoIdx_prc | Integer | Sim | Código do grupo de plano indexador utilizado na parcela |
| GrupoParc_Prc | Int | Sim | |
| StatusCbr_Prc | String | Não | |
| CapCorrecaoAtr_Prc | String | Sim | CAP do valor de correção por atraso da parcela |
| CapJuros_Prc | String | Sim | CAP do valor de juros da parcela |
| CapCorrecao_Prc | String | Sim | CAP do valor de correção da parcela |
| CapMulta_Prc | String | Sim | CAP do valor de multa da parcela |
| CapJurosAtr_Prc | String | Sim | CAP do valor de juros por atraso da parcela |
| CapAcrescimo_Prc | String | Sim | CAP do valor de acréscimo da parcela |
| CapDesconto_Prc | String | Sim | CAP do valor de desconto da parcela |
| Anexos_Prc | Int | Não | |
| CapDescontoAntec_Prc | String | Sim | CAP do valor de desconto de antecipação da parcela |
| CapTaxaBol_Prc | String | Sim | CAP do valor de taxa de boleto da parcela |
| ValorTaxaBol_prc | Double | Não | Valor da Taxa do boleto. |
| NumCtp_prc | Int | Não | Código do tipo de custa para parcelas do tipo Custas |
| OrigemCusta_prc | Int | Não | Indica se a origem da custa e pela obra ou administrativa |
| CobrarMulta_Prc | Int | Não | Indica se irá haver cobrança de multa por atraso na parcela do tipo custa específica |
| CobrarJurosAtr_prc | Int | Não | Indica se irá haver cobrança de juros por atraso na parcela do tipo custa específica |
| CobrarTxAdm_prc | Int | Não | Indica se irá haver cobrança de taxa de administração na parcela do tipo custa específica |
| CobrarImposto_prc | Int | Não | Indica se irá haver cobrança de imposto na parcela do tipo custa específica |
| CobrarCorrecao_prc | Int | Não | Indica se irá haver cobrança de correção na parcela do tipo custa específica |
| CobrarCPMF_prc | Int | Não | |
| RepassarLocador_prc | Int | Não | Indica se irá haver repasse ao locador para a parcela do tipo custa específica |
| ValDescontoCusta_prc | Double | Sim | Valor de desconto de custa vinculado à parcela. |
| CapDescontoCusta_prc | String | Sim | CAP do valor de desconto de custa da parcela |
| valDescontoImposto_prc | Double | Sim | Valor de desconto de imposto vinculado à parcela. |
| DtParc_prc | Date | Não | Data de vencimento da primeira parcela do grupo da parcela |
| TotParcGrupo_prc | Int | Não | Quantidade de parcelas do grupo da parcela |
| DataCad_prc | Date | Sim | Data de cadastro |
| DtJurosComJuros_prc | byte | Sim | Indica se as parcelas que possuem amortização Price ou SAC terão juros calculo nos casos que a data de vencimento esteja no mesmo mês (frequências mensais ou anuais) ou dia (frequência diária) da data de início de juros |
| Obs_Prc | String | Não | Observação da parcela do tipo custa específica |
| DataIniPeriodoAluguel_prc | Date | Não | Data de início de competência da parcela de aluguel. |
| CapRepasse_prc | String | Sim | CAP do valor de repasse da parcela |
| ValorReaj | Double | Sim | Valor reajustado da parcela. |
| vlrJurosParcela | Double | Sim | Valor do juros da parcela. |
| vlrCorrecao | Double | Sim | Valor da correção da parcela. |
| vlrJurosAtraso | Double | Sim | Valor do juros por atraso da parcela |
| valorMutla | Double | Sim | Valor da multa da parcela. |
| txJuros | Double | Sim | Taxa de juros da parcela, |
| txCorrecao | Double | Sim | Taxa de correção da parcela. |
| txMulta | Double | Sim | Taxa de multa da parcela |
| txJurosAtra | Double | Sim | Taxa de juros por atraso da parcela. |
| vlrRedisuo | Double | Sim | Valor do resíduo |
| vlrDescAdiantemento | Double | Sim | Valor do desconto por adiantamento. |
| vlrCorrecaoAtra | Double | Sim | Valor da correção por atraso. |
| txCorrecaoAtra | Double | Sim | Taxa da correção por atraso, |
| vlrPrincReal | Double | Sim | Valor principal da parcela |
| vlrTaxaBoleto | Double | Sim | Taxa do boleto. |
| vlrJurosAtraResiduo | Double | Sim | Valor do residuo do juros por atraso |
| vlrMultaResiduo | Double | Sim | Valor do residuo da multa |
Método BuscarParcelasRecebidas
Busca as parcelas recebidas da venda
Parâmetros
| Parâmetros | Tipo | Obrigatório | Descrição |
|---|---|---|---|
| Empresa | Int | Sim | Código da empresa |
| Obra | String | Sim | Código da obra |
| NumVen | Int | Sim | Número da venda |
Retorno
| Valor | Descrição |
|---|---|
| DataSet | Objeto com as informações das parcelas recebidas. |
Dicionário de dados
| Campo | Tipo | Obrigatório | Descrição |
|---|---|---|---|
| Empresa_rec | Int | Sim | Código da empresa |
| NumVend_rec | Int | Sim | Código da venda |
| Obra_Rec | String | Sim | Código da obra |
| NumParc_rec | Int | Sim | Número da parcela |
| ParcType_rec | String | Sim | Tipo do recebimento |
| Tipo_Rec | String | Sim | Código do tipo da parcela |
| NumParcGer_Rec | Int | Sim | Numeração única da parcela dentro da venda |
| NumReceb_rec | Double | Não | |
| DataRec | Date | Não | Data de recebimento da parcela |
| PorcentVl_rec | Double | Não | |
| Valor_rec | Double | Sim | Valor principal da parcela |
| ValorConf_rec | Double | Não | Valor confirmado de principal da parcela recebida |
| VlCorrecao_Rec | Double | Não | Valor não confirmado de correção da parcela recebida |
| VlCorrecaoConf_rec | Double | Não | Valor confirmado de correção da parcela recebida |
| VlMulta_rec | Double | Não | Valor não confirmado de multa por atraso da parcela recebida |
| VlMultaConf_Rec | Double | Não | Valor confirmado de multa por atraso da parcela recebida |
| VlJurosParc_Rec | Double | Não | Valor não confirmado de juros contratual da parcela recebida |
| VlJurosParcConf_rec | Double | Não | Valor confirmado de juros contratual da parcela recebida |
| VlJuros_rec | Double | Não | Valor não confirmado de juros por atraso da parcela recebida |
| vlJurosConf_rec | Double | Não | Valor confirmado de juros por atraso da parcela recebida |
| VlDesconto_rec | Double | Não | Valor não confirmado de desconto condicional da parcela recebida |
| VlDescontoConf_rec | Double | Não | Valor confirmado de desconto da parcela recebida |
| VlAcrescConf_Rec | Double | Não | Valor confirmado de acrescimo da parcela recebida |
| VlAcresc_Rec | Double | Não | Valor não confirmado de acréscimo da parcela recebida |
| Status_rec | Int | Não | Status da parcela. |
| User_rec | String | Não | Usuário que recebeu |
| UserDesc_rec | String | Não | |
| OrigParc_rec | Int | Não | Origem da parcela |
| DataVenci_rec | Date | Não | Data de vencimento da parcela. |
| JurosParc_Rec | Double | Sim | Taxa do primeiro juros da parcela |
| IdxReaj_rec | String | Sim | Código do índice de reajuste da parcela |
| AmortParc_rec | byte | Sim | Código do tipo de amortização de juros utilizado na parcela. 0 - Gradiente 1 - Price 2 - SAC 3 - Simples |
| BegEndParc_Rec | byte | Sim | Indica se irá utilizar referência Begin ou End quando utilizar o tipo de amortização Price: 0 - Begin 1 - End |
| DtIdxParc_rec | Date | Sim | Data de inicio de reajuste da parcela |
| DtJurParc_Rec | Date | Sim | Data de início da cobrança do primeiro juros da parcela |
| Cap_rec | String | Sim | CAP do valor do principal da parcela |
| TotParc_rec | Int | Não | Quantidade de parcelas do grupo da parcela |
| Dtparc_rec | Date | Não | Data de vencimento da primeira parcela do grupo da parcela |
| ValorResiduo_rec | Double | Sim | Valor de resíduo gerado para a parcela |
| GrupoIdx_rec | Int | Sim | Código do grupo de plano indexador utilizado na parcela |
| DtCalcReaj_rec | Date | Sim | Data de cálculo do reajuste. |
| VlrDescAdiant_rec | Double | Não | Valor do desconto por adiantamento. |
| VlCorrecaoAtrConf_Rec | Double | Nao | Valor confirmado de correção por atraso da parcela recebida |
| VlCorrecaoAtr_rec | Double | Não | Valor não confirmado de correção por atraso da parcela recebida |
| CapCorrecaoAtr_rec | String | Sim | CAP do valor de correção por atraso da parcela |
| CAP do valor de juros da parcela | String | Sim | CAP do valor de juros da parcela |
| CapCorrecao_Rec | String | Sim | CAP do valor de correção da parcela |
| CapMulta_rec | String | Sim | CAP do valor de multa da parcela |
| CapJurosAtr_rec | String | Sim | CAP do valor de juros por atraso da parcela |
| CapAcrescimo_rec | String | Sim | CAP do valor de acréscimo da parcela |
| CapDesconto_rec | String | Sim | CAP do valor de desconto da parcela |
| CapDescontoAntecip_rec | String | Sim | CAP do valor de desconto por antecipação da parcela |
| CapTaxaBol_rec | String | Sim | CAP do valor de taxa de boleto da parcela |
| VlTaxaBol_rec | Double | Não | Valor taxa boleto. |
| VlTaxaBolConf_rec | Double | Não | Valor confirmado taxa boleto. |
| NumCtp_rec | Int | Não | Identificador do tipo de custas. |
| OrigemCusta_rec | Int | Não | Identificada a origem da custa. |
| CobrarMulta_rec | byte | Sim | Define se cobra jurosmulta por atraso da parcela. |
| CobrarJurosAtr_Rec | byte | Sim | Define se cobra juros por atraso da parcela. |
| CobrarTxAdm_rec | byte | Sim | Define se cobra taxa de administração. |
| CobrarImposto_Rec | byte | Sim | Define se cobra imposto de renda. |
| CobrarCorrecao_rec | byte | Sim | Define se cobra correção da parcela. |
| CobrarCPMF_rec | byte | Não | |
| RepassarLocador_rec | byte | Sim | Define se repassa o valor do lançamento para o locador, caso seja uma venda do tipo aluguel. |
| ValDescontoCusta_Rec | Double | Sim | Valor de desconto depositado atribuido em uma parcela atraves de um lançamento de custas. |
| ValDescontoCustaConf_rec | Double | SIM | Valor de desconto atribuido em uma parcela atraves de um lançamento de custas. |
| ValDescontoImposto_rec | DOuble | Sim | Valor de desconto depositado atribuido em uma parcela atraves de um lançamento de imposto. |
| ValDescontoImpostoConf_Rec | Double | Sim | Valor de desconto atribuido em uma parcela através de um lançamento de imposto. |
| TotParcGrupo_rec | Int | Sim | Quantidade de parcelas do grupo da parcela |
| DataCad_rec | Date | Sim | Data de cadastro da parcela. |
| DataIniPeriodoAluguel_rec | Date | Não | Data de competência |
| CapRepasse_rec | String | SIM | CAP do valor de repasse da parcela |
| NumPcb_rec | Int | Sim | Código do padrão de cobrança utilizado na parcela |
| DataSegJuros_Rec | Date | Não | Data de início da cobrança do segundo juros da parcela |
| PorcSegJuros_rec | Date | Não | Taxa do segundo juros da parcela |
| CarenciaAtraso_rec | Int | Sim | Quantidade de dias de carência na cobrança de multa e juros por atraso da parcela |
| CobrarJurosProRata_rec | byte | Sim | Indica se o cálculo do reajuste da parcela será realizado de forma pró-rata |
| CapDescontoCondicional_rec | String | Sim | CAP do valor de desconto condicional da parcela |
| ValDescontoCondicional_rec | Double | Não | Valor não confirmado de desconto condicional da parcela recebida |
| ValDescontoCondicionalConf_rec | Double | Não | Valor confirmado de desconto condicional da parcela recebida |
Método ProcessarRecebimentoparcelas
Processa o recebimento de parcelas recebidas por softwares de terceiros, realizando a baixa das parcelas no UAU conforme informado nos objetos.
Parâmetros
Retorno
| Parâmetro | Tipo | Obrigatório | Descrição |
|---|---|---|---|
| dtoRecebimento | Objeto | Sim | Objeto com as informações básicas do recebimento e a lista de parcelas que serão recebidas. |
| dtoFormaPagamento | Objeto | Sim | Objeto que contém as formas de pagamento utilizada para o recebimento. Cheque, Bens, Dinheiro, Credito eletrônico e Cartão. |
Dicionário de dados
Definição dos objetos esperados para requisições/retorno.
DtoRecebimento
| Parâmetros | Tipo | Obrigatório | Descrição |
|---|---|---|---|
| empresa | Integer | Sim | Código da empresa no UAU |
| obra | String | Sim | Código da obra no UAU |
| contratoServico | Integer | Sim | Código do contrato de serviços |
| itemContrato | Integer | Sim | Código do item do contrato |
| servico | String | Sim | Código do serviço |
| dataInicio | String | Sim | Data de início do contrato de serviços |
| dataFim | String | Sim | Data final do contrato de serviços |
| mesPl | String | Não* | Mês do planejamento referente ao insumo vinculado no contrato |
| quantidade | Double | Sim | Quantidade a apontar do serviço |
| porcentagemAcomp | Double | Sim | Porcentagem de conclusão do apontamento |
| observacoes | String | Não | Observações pertinentes ao apontamento |
| etapa | String | Não | Descrição da etapa do serviço |
| codEstrutura | String | Não* | Código da estrutura que controla o serviço |
| sequencia | String | Não* | Código da sequência da estrutura |
| usuarioLogado | String | Sim | Login do usuário logado no sistema |
DTORecebimentoParcelaSimplificada
| Valor | Descrição |
|---|---|
| String | Mensagem de validações caso o acompanhamento não tenha sido efetivado. Se foi efetivado, retorna vazio. |
DtoFormaPagamento
| Parâmetro | Tipo | Obrigatório | Descrição |
|---|---|---|---|
| empresa | Integer | Sim | Código da empresa no UAU |
| contratoServico | Integer | Sim | Código do contrato de serviços no UAU |
| itemContrato | Integer | Sim | Código do item no contrato de serviços |
| servico | String | Sim | Código do serviço no UAU |
| quantidade | Double | Sim | valor que será excluído |
| sequencia | String | Não* | Sequência da estrutura |
| codigoEstrutura | Não* | Código da estrutura no UAU | |
| usuarioLogado | String | Sim | Código do usuário no UAU |
DTOCheque
| Parâmetro | Tipo | Obrigatório | Descrição |
|---|---|---|---|
| empresa | Integer | Sim | Código da empresa no UAU |
| obra | String | Sim | Código da obra no UAU |
| servico | String | Sim | Código do serviço no UAU |
| item | String | Sim | Código do item no orçamento |
| orcamento | Integer | Sim | Código do orçamento no UAU |
| periodo | String | Sim | Data que determina em qual período o serviço está orçado |
| quantidade | Double | Sim | Valor que será acompanhado no serviço |
| usuarioLogado | String | Sim | Código do usuário no UAU |
| sequencia | String | Não* | Sequência da estrutura |
DTOBens
| Parâmetro | Tipo | Obrigatório | Descrição |
|---|---|---|---|
| empresa | Integer | Sim | Código da empresa no UAU |
| obra | String | Sim | Código da obra no UAU |
| produto | Integer | Sim | Código do produto no UAU |
| contrato | Integer | Sim | Código do contrato do planejamento |
| item | String | Sim | Código do item no planejamento |
| servico | String | Sim | Código do serviço no UAU |
| mes | String | Sim | Data que determina em qual período do planejamento |
| usuario | String | Sim | Código do usuário no UAU |
| qtde | Double | Sim | Valor a ser acompanhado no serviço |
| sequencia | String | Não* | Sequência da estrutura |
DTODinheiro
| Parâmetros | Tipo | Obrigatório | Descrição |
|---|---|---|---|
| empresa | Integer | Sim | Código da empresa no UAU |
| obra | String | Sim | Código da obra no UAU |
| servico | String | Sim | Código do serviço |
| item | String | Sim | Código do item no orçamento |
| orcamento | Integer | Sim | Código do orçamento |
| periodo | String | Sim | Data em que deseja impactar no orçamento |
| quantidade | Double | Sim | Quantidade a apontar do serviço |
| sequencia | String | Não* | Código da sequência da estrutura |
DTOCreditoEletronico
| Parâmetros | Tipo | Obrigatório | Descrição |
|---|---|---|---|
| empresa | Integer | Sim | Código da empresa no UAU |
| obra | String | Sim | Código da obra no UAU |
| servico | String | Sim | Código do serviço |
| item | String | Sim | Código do item no orçamento |
| orcamento | Integer | Sim | Código do orçamento |
| periodo | String | Sim | Data em que deseja impactar no orçamento |
| quantidade | Double | Sim | Quantidade a apontar do serviço |
| sequencia | String | Não* | Código da sequência da estrutura |
DTOCartao
| Parâmetros | Tipo | Obrigatório | Descrição |
|---|---|---|---|
| empresa | Integer | Sim | Código da empresa no UAU |
| obra | String | Sim | Código da obra no UAU |
| produto | Integer | Sim | Código do produto no planejamento |
| contrato | Integer | Sim | Código do contrato do planejamento |
| item | String | Sim | Código do item no planejamento |
| servico | String | Sim | Código do serviço no planejamento |
| mes | String | Sim | Mês do planejamento |
| usuario | String | Sim | Usuário logado no UAU |
| qtde | Double | Sim | Quantidade a ser excluída |
| sequencia | String | Não* | Código da sequência da estrutura |