SnapMall - CRM para administradores de shopping

Skip to end of metadata
Go to start of metadata

You are viewing an old version of this page. View the current version.

Compare with Current View Page History

« Previous Version 8 Next »

O objeto Locação (snap_mall_locacao_c) contém as informações referente a um processo de locação.

Para criação de uma Locação se faz necessário previamente possuir cadastrado na base : Shopping e Unidade.


Campos de locação

Rótulo do campoNome de APITipo de dadosObrigatórioDescrição
Consultorsnap_mall__Consultor__cPesquisa(Usuário)
Informação de usuário de sistema sistema do consultor responsável pela locação
Criado porCreatedByIdPesquisa(Usuário)XPreenchimento automático com o usuário de sistema que realizou a criação do cadastro ou usuário da integração
Data da publicaçãosnap_mall__Data_publicacao__cData
Informação da data de publicação do processo de locação
Data de iníciosnap_mall__data_inicio__cData
Informação da data de inicio da locação
Data de términosnap_mall__data_termino__cData
Informação da data de término da locação
Duração da locaçãosnap_mall__Duracao__cFórmula (Número)
Campo não editável que calcula o período conforme a informação da data de inicio e termino da locação
Etapasnap_mall__Etapa__cLista de opçõesX

Preenchimento automático conforme a etapa do processo de locação

Opções possíveis

  • 1 . Prospecção
  • 2 . Proposta
  • 3 . Contrato
  • 4 . Comissão
Fechadosnap_mall__fechado__cCaixa de seleção

Informação se a locação encontra-se encerrada

Opções possíveis

  • true
  • false
ID Externosnap_mall__id_externo__cTexto(80) (ID externo) (Não-diferenciação exclusiva de maiúsculas e minúsculas)
Id do sistema ERP, que poderá ser informado no momento da inserção da conta, para futuras atualizações, através deste Id.
LocaçãoNameNumeração automáticaXID do processo de locação, geração automática no momento da inclusão do registro
Loja alugadasnap_mall__Loja_alugada__cCaixa de seleção

Informação se a locação encontra-se alugada

Opções possíveis

  • true
  • false
ProprietárioOwnerIdPesquisa(Usuário,Grupo)

ID de um usuário de sistema salesforce, se não for preenchido será o usuário de integração.

Publicadosnap_mall__Publicado__cCaixa de seleção

Informação se a locação encontra-se publicada

Opções possíveis

  • true
  • false
Shoppingsnap_mall__shopping__cPesquisa(Shopping)XInformação relacionada a qual shopping a loja pertence, contém o ID do shopping cadastrado no objeto shopping
Situaçãosnap_mall__situacao__cLista de opçõesX

Preenchimento automático conforme a situação dentro da etapa do processo de locação

Opções possíveis

  • Novo
  • Rachunho
  • Contrato assinado pelo cliente
  • Contrato assinado pela empresa
  • Prospecção cancelada
Unidadesnap_mall__loja__cPesquisa(Unidade)XInformação relacionada a qual loja esta neste processo de locação, contém o ID da unidade locatícia cadastrada no objeto unidade
Valorsnap_mall__Valor__cMoeda(12, 2)
Informação do valor referente ao processo de locação
Valor de tabela do AMMsnap_mall__Valor_tabela_AMM__cFórmula (Moeda)
Campo calculado
Valor unitário de tabela do AMMsnap_mall__Valor_unitario_tabela_AMM__cMoeda(12, 2)
Informação de valor 
Última modificação feita porLastModifiedByIdPesquisa(Usuário)XInformação do usuário de sistema que realizou a ultima modificação ou usuário da integração

  Criar Locação:

                 Método : POST

                 URI: https://{{dominio}}/services/data/{{versao}}/sobjects/snap_mall__locacao__c/

                 Descrição: Método de criação de um Locação(snap_mall__locacao__c), informando todos os campos utilizados por uma Locação.

Request
{
"OwnerId":"0051J000004ppUV",
"snap_mall__Etapa__c":"1. Prospecção",
"snap_mall__Consultor__c":"0051J000004ppUV",
"snap_mall__situacao__c":"Em prospecção",
"snap_mall__Valor__c":"654123",
"snap_mall__Loja_alugada__c":"true",
"snap_mall__fechado__c":"false",
"snap_mall__shopping__c":"a001J00001Kw3TI",
"snap_mall__loja__c":"a041J000017EJQ7",
"snap_mall__data_inicio__c":"2018-06-07",
"snap_mall__Publicado__c":"false",
"snap_mall__data_termino__c":"2019-06-07",
"snap_mall__Data_publicacao__c":"2019-06-07",
"snap_mall__Concluido__c":"false",
"snap_mall__id_externo__c":"123456789"
}
Response

{
"id": "a051J00003r3o8YQAQ",
"success": true,
"errors": []
}

Atualizar Locação:

               Método :PATCH

               URI com ID salesforce:https://{{dominio}}/services/data/{{versao}}/sobjects/snap_mall__locacao__c/ (Id do registro salesforce)

               URI com ID externo: https://{{dominio}}/services/data/{{versao}}/sobjects/snap_mall__locacao__c/snap_mall__id_externo__c/ (Id externo)

               Descrição: 

Método de atualização de uma Locação(snap_mall__locacao__c)  de qualquer tipo, informando no body apenas os  campos que se deseja atualizar. 

               Existem duas possibilidades de atualização da Locação: 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

{
"OwnerId":"0051J000004ppUV",
"snap_mall__Etapa__c":"2. Proposta",
"snap_mall__situacao__c":"Contato Realizado"
}

Response

                               Response de atualização em caso de sucesso retorna vazio.

Deletar Locação:

Método : DELETE

URI com ID salesforce: https://{{dominio}}/services/data/{{versao}}/sobjects/snap_mall__locacao__c/ (Id do registro salesforce)

URI com ID externo: https://{{dominio}}/services/data/{{versao}}/sobjects/c/snap_mall__locacao__c/ (Id externo)

Descrição: Método de deleção de uma Locação(snap_mall__locacao__c) de qualquer tipo.  Existem duas possibilidades de deleção da Locação: Um com Id Salesforce o outro com o Id Externo, a diferenciação desta chamada vai ser na URI.

Request

Body de deleção é vazio.

Response

Response de deleção retorna vazio.

  • No labels