O objeto Contrato (snap_mall__contrato__c) contém todas as informações de cadastro do contrato.
Possuem três tipos de contrato (Tipo de registro), que terão suas particulares obrigatoriedades, e que serão delimitados seus métodos individualmente.
Tipos de registro
...
...
...
Está informação dos tipos de registros é importante, pois para o cadastro e atualização de cada contrato, dependendo do tipo de registro existem diferentes campos a serem obrigatoriamente informados,e campos que podem ser informados ou não.
Campos do contrato
...
Determina se o contrato encontra-se assinado
Opções possíveis:
- true
- false
...
...
O objeto Contrato (snap_mall__contrato__c) contém todas as informações de cadastro do contrato.
Possuem três tipos de contrato (Tipo de registro), que terão suas particulares obrigatoriedades, e que serão delimitados seus métodos individualmente.
Para criação de uma Contrato e faz necessário previamente possuir cadastrado na base : Conta, Shopping e Unidade.
Versões do Contrato
- O contrato possui versões para armazenar o histórico de alteração de um contrato
- Quando o contrato é criado é gerado uma V0 deste contrato
- Opcionalmente para uma historicidade do contrato é necessário sempre que houver uma alteração que seja de grande relevância, criar-se uma nova versão deste contrato. Está versão é criada com a inserção de um registro no Objeto "Versão do contrato" (snap_mall__versao_contrato__c)
Tipos de registro
Rótulo tipo de registro | Nome de API |
|---|---|
| Locação Temporária | |
| Leasing | |
| Renovação de locação temporária |
Está informação dos tipos de registros é importante, pois para o cadastro e atualização de cada contrato, dependendo do tipo de registro existem diferentes campos a serem obrigatoriamente informados,e campos que podem ser informados ou não.
Campos do contrato
| Rótulo do campo | Nome de API | Tipo de dados | Obrigatório | Descrição |
|---|---|---|---|---|
| % de multa para 1o.ano | snap_mall__percentual_multa_1ano__c | Porcentagem(10, 2) | Informação do valor % de multa 1o. ano do contrato | |
| % de multa para 2o.ano | snap_mall__percentual_multa_2ano__c | Porcentagem(10, 2) | Informação do valor % de multa 2o. ano do contrato | |
| % de multa para 3o.ano | snap_mall__percentual_multa_3ano__c | Porcentagem(10, 2) | Informação do valor % de multa 3o. ano do contrato | |
| % de sinal do CDU | snap_mall__percentual_sinal_cdu__c | Porcentagem(10, 2) | Informação do valor % de sinal CDU | |
| % do CDI para correção do mútuo | snap_mall__percentual_cdi_correcao_mutuo__c | Porcentagem(10, 4) | Informação do valor % de correção CDI mútuo | |
| Asset | snap_mall__asset__c | Pesquisa(Usuário) | O usuário de sistema salesforce que pode ser usado em alçada de aprovação de operações de sistema | |
| Assinado pelo cliente | snap_mall__Assinado_cliente__c | Caixa de seleção | Determina se o contrato encontra-se assinado Opções possíveis:
| |
| Atividade SAP | snap_mall__atividade_sap__c | Pesquisa(Atividade do shopping) | ID da atividade cadastrada no objeto Atividade | |
| Considerações operacionais | snap_mall__consideracoes_operacionais__c | Área de texto longo(5000) | Informação das considerações operacionais | |
| Contato | snap_mall__Contato__c | Pesquisa(Contato) | ID do contato do contrato cadastrado no objeto Contato | |
| Contato do locatário | snap_mall__contato_locatario__c | Pesquisa(Contato) | ID do locatário do contrato cadastrado no objeto Contato | |
| Contrato | Name | Numeração automática | ID do contrato, geração automática no momento da inclusão do registro | |
| Criado por | CreatedById | Pesquisa(Usuário) | Preenchimento automático com o usuário de sistema que realizou a criação do cadastro ou usuário da integração | |
| Data da assinatura do locador | data_assinatura_locador__c | Data/Hora | ||
| Data da assinatura do locatário | snap_mall__Data_assinatura_cliente__c | Data | ||
| Data da assinatura do superintendente | snap_mall__Data_assinatura_superintendente__c | Data | ||
| Data da inauguração | snap_mall__data_inauguracao__c | Data | ||
| Data de aprovação | snap_mall__Data_aprovacao__c | Data | ||
| Data de aprovação da documentação | data_aprovacao_documentacao__c | Data/Hora | ||
| Data de assinatura da empresa | snap_mall__Data_assinatura_empresa__c | Data | ||
| Data de entrega da EUC | snap_mall__data_entrega_euc__c | Data | ||
| Data de entrega do projeto | snap_mall__data_entrega_projeto__c | Data | ||
| Data de envio para jurídico | data_envio_juridico__c | Data/Hora | ||
| Data de início | snap_mall__Data_inicio__c | Data | ||
| Data de início da vigência | snap_mall__Data_inicio_vigencia__c | Data | ||
| Data de recebimento da minuta | data_recebimento_minuta__c | Data/Hora | ||
| Data de término | snap_mall__Data_termino__c | Data | ||
| Data de término de vigência | snap_mall__Data_termino_vigencia__c | Data | ||
| Data do contrato | snap_mall__data_contrato__c | Data | ||
| Dia de pagamento aluguel percentual | snap_mall__Dia_pagamento_aluguel_percentual__c | Número(2, 0) | ||
| Dia de pagamento encargos específicos | snap_mall__Dia_pagamento_encargos_especificos__c | Número(2, 0) | ||
| Dia de vencimento do aluguel | snap_mall__Dia_vencimento_aluguel__c | Número(2, 0) | ||
| Dia de vencimento do condomínio | snap_mall__Dia_vencimento_condominio__c | Número(2, 0) | ||
| Dias de carência | snap_mall__dias_carencia__c | Número(3, 0) | ||
| Encargos comuns | snap_mall__Encargos_comuns__c | Moeda(10, 2) | ||
| Experiências comerciais | snap_mall__experiencias_comerciais__c | Área de texto longo(5000) | ||
| Fechado | snap_mall__Concluido__c | Caixa de seleção | ||
| Finalidade | snap_mall__finalidade__c | Área de texto longo(2000) | ||
| Gerente comercial | snap_mall__gerente_comercial__c | Pesquisa(Usuário) | ||
| Grupo SAP | snap_mall__grupo_sap__c | Pesquisa(Grupo) | ID da grupo cadastrada no objeto Grupo | |
| ID Externo | snap_mall__ID_Externo__c | Texto(20) (ID externo) (Não-diferenciação exclusiva de maiúsculas e minúsculas) | ||
| Início da elaboração do contrato | snap_mall__inicio_elaboracao_contrato__c | Data | ||
| Início para pagamento do mútuo | snap_mall__inicio_pagamento_mutuo__c | Data | ||
| Locador | snap_mall__locador__c | Pesquisa(Conta) | ID do locador do contrato cadastrado no objeto Conta | |
| Locatário | snap_mall__Cliente__c | Pesquisa(Conta) | ID do locatário do contrato cadastrado no objeto Conta | |
| Locação | snap_mall__Venda__c | Pesquisa(Locação) | ID da locação do contrato cadastrado no objeto Locação | |
| Marca | snap_mall__marca__c | Pesquisa(Conta) | ID da marca cadastrada no objeto Conta | |
| Modelo de contrato | snap_mall__Modelo_de_contrato__c | Lista de opções | Lista de modelo de contrato Opções possíveis
| |
| Mês data base | snap_mall__mes_data_base__c | Texto(50) | Informação do mês base do contrato | |
| Nova condição contratual | snap_mall__nova_condicao_contratual__c | Área de texto longo(5000) | Informação de nova condição contratual | |
| Novo % de AMM | snap_mall__novo_percentual_amm__c | Porcentagem(10, 4) | Informação de novo % AMM | |
| Número | snap_mall__Numero_contrato__c | Texto(30) | Informação do número do contrato | |
| Número de parcelas do CDU | snap_mall__numero_parcelas_cdu__c | Número(3, 0) | Informação de parcelas CDU | |
| Número de parcelas do mútuo | snap_mall__numero_parcelas_mutuo__c | Número(3, 0) | Informação de parcelas mutuo | |
| Observações aluguel mínimo | snap_mall__Observacoes_aluguel_minimo__c | Área de texto longo(32768) | Informação de observações do aluguel minimo do contrato | |
| Observações aluguel percentual | snap_mall__Observacoes_aluguel_percentual__c | Área de texto longo(32768) | Informação do % de aluguel contrato | |
| Observações condições especiais | snap_mall__Observacoes_condicoes_especiais__c | Área de texto longo(32768) | Informação de condições especiais contrato | |
| Observações contratuais | snap_mall__observacoes_gerais__c | Área de texto longo(32768) | Informações de observações contratuais | |
| Observações encargos comuns | snap_mall__Observacoes_encargos_comuns__c | Área de texto longo(32768) | Informação de encargos comuns | |
| Observações encargos específicos | snap_mall__Observacoes_encargos_especificos__c | Área de texto longo(10000) | Informação de encargos específicos | |
| Observações para fit-out | snap_mall__observacoes_fit_out__c | Área de texto longo(5000) | Informação de fit-out | |
| Observações para mútuo | snap_mall__observacoes_mutuo__c | Área de texto longo(5000) | Informação para o mutuo | |
| Outra opção de consolidação | snap_mall__outra_opcao_consolidacao__c | Texto(80) | Informação de outra opção de consolidação | |
| Período da consolidação | snap_mall__periodo_consolidacao__c | Lista de opções | ||
| Prazo do contrato | snap_mall__prazo_contrato__c | Número(2, 0) | Informação do prazo do contrato | |
| Proposta | snap_mall__proposta__c | Pesquisa(Proposta) | ID da proposta relacionada ao contrato | |
| Proposta com fifty | snap_mall__proposta_fifty__c | Caixa de seleção | Determina se a proposta associada ao contrato é uma proposta fifity Opções possíveis:
| |
| Proprietário | OwnerId | Pesquisa(Usuário,Grupo) | Usuário de sistema que foi responsável pela criação do registro ou usuário da integração | |
| Prospecção | snap_mall__prospecao__c | Pesquisa(Prospecção) | ID da prospecção relacionada a proposta e contrato | |
| Quantidade Periodo AMM | snap_mall__quantidade_periodo_amm__c | Resumo da totalização (COUNT Período do contrato) | Campo calculado | |
| Quantidade Periodo CTO | snap_mall__quantidade_periodo_cto__c | Resumo da totalização (COUNT Período do contrato) | Campo calculado | |
| Renovação | snap_mall__Renovacao__c | Pesquisa(Renovação) | ||
| Responsável pela negociação | snap_mall__Consultor__c | Pesquisa(Usuário) | Id do usuário salesforce | |
| Revisão | snap_mall__Revisao__c | Número(3, 0) | Informação do número da revisão do contrato | |
| Sazonalidade para dezembro | snap_mall__Sazonalidade_dezembro__c | Porcentagem(5, 2) | Informação % de sazonalidade para dezembro | |
| Sazonalidade para maio | snap_mall__Sazonalidade_maio__c | Porcentagem(5, 2) | Informação % de sazonalidade para maio | |
| Sazonalidade para novembro | snap_mall__Sazonalidade_novembro__c | Porcentagem(5, 2) | Informação % de sazonalidade para novembro | |
| Segundo comissionado | snap_mall__segundo_comissionado__c | Pesquisa(Usuário) | ID usuário de sistema salesforce que terá pa | |
| Shopping | snap_mall__Shopping__c | Pesquisa(Shopping) | ID do shopping cadastrado no objeto shopping | |
| Situação | snap_mall__Situacao__c | Lista de opções | Preenchimento automático conforme a situação dentro da etapa do processo de contrato Opções possíveis
| |
| Soma AMM | snap_mall__soma_amm__c | Resumo da totalização (SUM Período do contrato) | Campo calculado | |
| Soma CTO | snap_mall__soma_cto__c | Resumo da totalização (SUM Período do contrato) | Campo calculado | |
| Subgrupo SAP | snap_mall__subgrupo_sap__c | Pesquisa(Subgrupo) | ID do subgrupo cadastrada no objeto Subgrupo | |
| Tem consolidação | snap_mall__tem_consolidacao__c | Caixa de seleção | Determina se há consolidação Opções possíveis:
| |
| Tem fiador | snap_mall__tem_fiador__c | Caixa de seleção | Determina se há fiador para este contrato de locação Opções possíveis:
| |
| Tem fit-out | snap_mall__tem_fit_out__c | Caixa de seleção | Determina se há fit-out Opções possíveis:
| |
| Tem mútuo | snap_mall__tem_mutuo__c | Caixa de seleção | Determina se há mutuo Opções possíveis:
| |
| Tipo de carência | snap_mall__tipo_carencia__c | Lista de opções | Lista de tipos de carência Opções possíveis
| |
| Tipo de condomínio | snap_mall__tipo_condominio__c | Lista de opções | Lista de tipos de condominio Opções possíveis
| |
| Tipo de condomínio para consolidação | snap_mall__tipo_condominio_consolidacao__c | Lista de opções | ||
| Tipo de consolidação | snap_mall__tipo_consolidacao__c | Lista de opções | ||
| Tipo de contrato | snap_mall__tipo_contrato__c | Lista de opções | Lista de tipos de contrato Opções possíveis
| |
| Tipo de fundo promoção para consolidação | snap_mall__tipo_fundo_promocao_consolidacao__c | Lista de opções | Lista de tipos de FP para consolidação Opções possíveis
| |
| Tipo de prazo | snap_mall__Tipo_prazo__c | Lista de opções | Lista de tipos de prazo Opções possíveis
| |
| Tipo de registro | RecordTypeId | Tipo de registro | ID do Tipo de registro ou Nome de API do tipo de registro * Necessário informar o tipo de registro no cadastro | |
| Término da elaboração do contrato | snap_mall__termino_elaboracao_contrato__c | Data | ||
| Unidade | snap_mall__Loja__c | Pesquisa(Unidade) | ID da unidade locaticia cadastrada no objeto unidade | |
| Validado | snap_mall__Validado__c | Caixa de seleção | Determina se o contrato encontra-se validado Opções possíveis:
| |
| Valor do aluguel | snap_mall__Valor_aluguel_locacao_temporaria__c | Moeda(10, 2) | Informação do valor do aluguel | |
| Valor do aluguel % | snap_mall__Valor_aluguel_percentual__c | Porcentagem(3, 2) | informação do % do valor de aluguel | |
| Valor do AMM médio por m2 | snap_mall__valor_amm_medio__c | Fórmula (Moeda) | Campo calculado | |
| Valor do CDU | snap_mall__valor_cdu_m2__c | Moeda(10, 2) | Informação do valor de CDU | |
| Valor do contrato | snap_mall__Valor_contrato__c | Moeda(12, 2) | Informação do valor do contrato | |
| Valor do CTO médio | snap_mall__valor_cto_medio__c | Fórmula (Moeda) | Informação do valor do CTO médio | |
| Valor do fit-out | snap_mall__valor_fit_out__c | Moeda(10, 2) | Informação do valor fit-out | |
| Valor do mútuo | snap_mall__valor_mutuo__c | Moeda(10, 2) | Informação do valor do mutuo | |
| Valor fixo condomínio para consolidação | snap_mall__valor_fixo_condominio_consolidacao__c | Moeda(10, 2) | Informação do valor fixo do condomínio | |
| Valor fixo do condomínio | snap_mall__valor_fixo_condominio__c | Moeda(10, 2) | Informação do valor do condomínio | |
| Valor fixo do fundo de promoção | snap_mall__valor_fixo_fundo_promocao__c | Moeda(10, 2) | Informação do valor FP, campo validado conforme a regra do valor mínimo e máximo FP cadastrado no objeto Shopping | |
| Valor fixo fundo promoção consolidação | snap_mall__valor_fixo_fundo_promocao_consolidacao__c | Moeda(10, 2) | Informação do valor FP consolidado | |
| Valor total do CDU | snap_mall__valor_cdu__c | Fórmula (Moeda) | Campo calculado | |
| Versão ativa | snap_mall__versao_ativa__c | Pesquisa(Versão do contrato) | ||
| Versão da proposta | snap_mall__versao_proposta__c | Pesquisa(Versão da proposta) | ||
| VGL | snap_mall__vgl__c | Moeda(16, 2) | Informação do valor VGL | |
| Última modificação feita por | LastModifiedById | Pesquisa(Usuário) | X | Informação do usuário de sistema que realizou a ultima modificação ou usuário da integração |
Criar contrato de Locação temporária:
Método : POST
URI: https://{{dominio}}/services/data/{{versao}}/sobjects/snap_mall__contrato__c/
Descrição: Método de criação de um Contrato(snap_mall__contrato__c) do tipo Locação temporária, informando todos os campos utilizados por um contrato deste tipo.
Request |
|---|
{ } |
Response |
|---|
{ |
Criar contrato de Leasing:
Método : POST
URI: https://{{dominio}}/services/data/{{versao}}/sobjects/snap_mall__contrato__c/
Descrição: Método de criação de um Contrato(snap_mall__contrato__c) do tipo Leasing, informando todos os campos utilizados por um contrato deste tipo.
Request |
|---|
{ |
| Response |
|---|
| { "id": "a071J00000PoBEoQAN", "success": true, "errors": [] } |
Criar contrato de Renovação de locação temporária:
Método : POST
URI: https://{{dominio}}/services/data/{{versao}}/sobjects/snap_mall__contrato__c/
Descrição: Método de criação de um Contrato(snap_mall__contrato__c) do tipo Renovação de locação temporária, informando todos os campos utilizados por um contrato deste tipo.
Request |
|---|
| Response |
|---|
Atualizar Contrato:
Método :PATCH
URI com ID salesforce:https://{{dominio}}/services/data/{{versao}}/sobjects/snap_mall__contrato__c/ (Id do registro salesforce)
URI com ID externo: https://{{dominio}}/services/data/{{versao}}/sobjects/snap_mall__contrato__c/snap_mall__ID_Externo__c/ (Id externo)
Descrição:
Método de atualização de um Contrato(snap_mall__contrato__c) de qualquer tipo, informando no body apenas os campos que se deseja atualizar.
Existem duas possibilidades de atualização do Contrato: Um com Id Salesforce o outro com o Id Externo, a diferenciação desta chamada vai ser na URI.
O método PATCH pode ser utilizado par Upsert, em caso do Id externo informado não existir na base e contiver todos os campos obrigatórios no body.
Request |
|---|
{ } |
Response |
|---|
Response de atualização em caso de sucesso retorna vazio.
Deletar Contrato:
Método : DELETE
URI com ID salesforce: https://{{dominio}}/services/data/{{versao}}/sobjects/snap_mall__contrato__c/ (Id do registro salesforce)
URI com ID externo: https://{{dominio}}/services/data/{{versao}}/sobjects/snap_mall__contrato__c/snap_mall__ID_Externo__c/ (Id externo)
Descrição: Método de deleção de um Contrato(snap_mall__contrato__c) de qualquer tipo. Existem duas possibilidades de deleção do Contrato: Um com Id Salesforce o outro com o Id Externo, a diferenciação desta chamada vai ser na URI
| Resquest |
|---|
Body de deleção é vazio.
| Response |
|---|
Response de deleção retorna vazio.