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 campo | Nome de API | Tipo de dados | Obrigatório | Descrição |
---|---|---|---|---|
Consultor | snap_mall__Consultor__c | Pesquisa(Usuário) | Informação de usuário de sistema sistema do consultor responsável pela locação | |
Criado por | CreatedById | Pesquisa(Usuário) | X | Preenchimento automático com o usuário de sistema que realizou a criação do cadastro ou usuário da integração |
Data da publicação | snap_mall__Data_publicacao__c | Data | Informação da data de publicação do processo de locação | |
Data de início | snap_mall__data_inicio__c | Data | Informação da data de inicio da locação | |
Data de término | snap_mall__data_termino__c | Data | Informação da data de término da locação | |
Duração da locação | snap_mall__Duracao__c | Fó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 | |
Etapa | snap_mall__Etapa__c | Lista de opções | X | Preenchimento automático conforme a etapa do processo de locação Opções possíveis
|
Fechado | snap_mall__fechado__c | Caixa de seleção | Informação se a locação encontra-se encerrada Opções possíveis
| |
ID Externo | snap_mall__id_externo__c | Texto(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ção | Name | Numeração automática | X | ID do processo de locação, geração automática no momento da inclusão do registro |
Loja alugada | snap_mall__Loja_alugada__c | Caixa de seleção | Informação se a locação encontra-se alugada Opções possíveis
| |
Proprietário | OwnerId | Pesquisa(Usuário,Grupo) | ID de um usuário de sistema salesforce, se não for preenchido será o usuário de integração. | |
Publicado | snap_mall__Publicado__c | Caixa de seleção | Informação se a locação encontra-se publicada Opções possíveis
| |
Shopping | snap_mall__shopping__c | Pesquisa(Shopping) | X | |
Situação | snap_mall__situacao__c | Lista de opções | X | Preenchimento automático conforme a situação dentro da etapa do processo de locação Opções possíveis
|
Unidade | snap_mall__loja__c | Pesquisa(Unidade) | X | |
Valor | snap_mall__Valor__c | Moeda(12, 2) | Informação do valor referente ao processo de locação | |
Valor de tabela do AMM | snap_mall__Valor_tabela_AMM__c | Fórmula (Moeda) | Campo calculado | |
Valor unitário de tabela do AMM | snap_mall__Valor_unitario_tabela_AMM__c | Moeda(12, 2) | Informação de valor | |
Ú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 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 |
---|
{ |
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 |
---|
{ |
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/snap_mall__locacao__c/snap_mall__id_externo__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.