...
...
...
...
...
...
...
...
...
...
O objeto Período do contrato (snap_mall__periodo_contrato__c) contém todas as informações de cadastro do período do contrato.
Possuem dois 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 um Período do contrato se faz necessário previamente possuir cadastrado na base : Contrato
Tipos de registro
Rótulo tipo de registro | Nome de API |
|---|---|
| Locação Temporária | |
| Leasing |
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 de Período do contrato
| Rótulo de campo | Nome de API | Descrição | Obrigatório | Descrição |
|---|---|---|---|---|
| Contrato | snap_mall__contrato__c | Detalhes do mestre(Contrato) | X | ID do contrato cadastrado no objeto contrato |
| 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 |
| Ordem | snap_mall__ordem__c | Número(2, 0) | X | Informação da ordem do período |
| Período | Name | Texto(80) | X | Informação de identificação do período |
| Tipo de condomínio | snap_mall__tipo_condominio__c | Lista de opções | ||
| Tipo de cálculo | snap_mall__tipo_calculo__c | Lista de opções | ||
| Tipo de fundo de promoção | snap_mall__tipo_fundo_promocao__c | Lista de opções | ||
| Tipo de registro | RecordTypeId | Tipo de registro | X | ID do Tipo de registro ou Nome de API do tipo de registro * Necessário informar o tipo de registro no cadastro |
| Tipo valor do aluguel | snap_mall__tipo__c | Lista de opções | X | Lista do tipo de valor de aluguel Opções disponiveis
|
| Valor do aluguel % | snap_mall__valor_aluguel_percentual__c | Porcentagem(10, 4) | Informação do % do valor do aluguel | |
| Valor do AMM | snap_mall__valor_amm__c | Fórmula (Moeda) | ||
| Valor do AMM | snap_mall__Valor_amm_locacao_temporaria__c | Moeda(10, 2) | Informação do valor do AMM | |
| Valor do AMM/m2 | snap_mall__valor_amm_m2__c | Moeda(10, 4) | ||
| Valor do CTO | snap_mall__valor_cto__c | Fórmula (Moeda) | ||
| Valor do CTO % | snap_mall__valor_cto_percentual__c | Porcentagem(10, 4) | ||
| Valor do CTO/m2 | snap_mall__valor_cto_m2__c | Moeda(10, 4) | ||
| Valor fixo do condomínio | snap_mall__valor_fixo_condominio__c | Moeda(10, 2) | X | Informação do valor fixo de condomínio |
| Valor fixo do fundo de promoção | snap_mall__valor_fixo_fundo_promocao__c | Moeda(10, 2) | ||
| Valor fixo total | snap_mall__valor_fixo_total__c | Moeda(16, 2) | X | Informação do valor fixo total |
| Ú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 |
- Apesar de existir dois tipos de registros de Períodos os campos informados são os mesmos, a diferença deve ser no RecordType para diferenciação de Locação Temporária e Leasing.
Criar Período do contrato:
Método : POST
URI: https://{{dominio}}/services/data/{{versao}}/sobjects/snap_mall__periodo_contrato__c/
Descrição: Método de criação de um Período do contrato(snap_mall__periodo_contrato__c), informando todos os campos utilizados por um período do contrato.
Request |
|---|
| { "Name":"Intermédio", "snap_mall__contrato__c":"a07o00000024EPz", "snap_mall__ordem__c":"2", "snap_mall__Valor_amm_locacao_temporaria__c":"16000.00", "snap_mall__valor_aluguel_percentual__c":"3", "snap_mall__valor_fixo_condominio__c":"23000.00", "snap_mall__valor_fixo_total__c":"23000.00" } |
| Response |
|---|
| { "id": "a0T1J00000ACBnNUAX", "success": true, "errors": [] } |
Atualizar Período do contrato:
Método :PATCH
URI com ID salesforce:https://{{dominio}}/services/data/{{versao}}/sobjects/snap_mall__periodo_contrato__c/ (Id do registro salesforce)
Descrição:
Método de atualização de um Período (snap_mall__periodo_contrato__c) , informando no body apenas os campos que se deseja atualizar.
Request |
|---|
| { "Name":"Intermédio", "snap_mall__ordem__c":"3" } |
Response |
|---|
Response em caso de sucesso da atualização retornará vazio.
Deletar Período do contrato:
Método : DELETE
URI com ID salesforce: https://{{dominio}}/services/data/{{versao}}/sobjects/snap_mall__periodo_contrato__c/ (Id do registro salesforce)
Descrição: Método de deleção de um Período do contrato(snap_mall__periodo_contrato__c) de qualquer tipo.
Request |
|---|
Body de deleção é vazio.
Response |
|---|
Response de deleção retorna vazio.