O objeto Documento do contrato (snap_mall__documento_contrato__c) contém todas as informações de cadastro do documento do contrato.
Para criação de um Documento de contrato se faz necessário previamente possuir cadastrado na base : Contrato
Campos de Documento do contrato
| Rótulo do campo | Nome de API | Tipo de dados | 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 |
| Documento | Name | Texto(80) | X | Informação de identificação do documento do contrato |
| Observação | snap_mall__observacao__c | Área de texto longo(1000) | Informação de observação do documento do contrato | |
| Pendência | snap_mall__pendencia__c | Área de texto longo(1000) | Informação de pendência do documento do contrato | |
| Situação | snap_mall__situacao__c | Lista de opções | Lista de situações do documento do contrato* | |
| Tipo de documento | snap_mall__tipo_documento__c | Lista de opções | Lista de tipo do documentos do contrato* | |
| Ú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 Documento do contrato:
Método : POST
URI: https://{{dominio}}/services/data/{{versao}}/sobjects/snap_mall__documento_contrato__c/
Descrição: Método de criação de um Documento do contrato(snap_mall__documento_contrato__c), informando todos os campos utilizados para um documento do contrato.
Request |
|---|
| { "Name":"Confidencialidade", "snap_mall__Contrato__c":"a07o00000024EPz", "snap_mall__situacao__c":"Aguardando", "snap_mall__pendencia__c":"Envio do documento", "snap_mall__observacao__c":"Documento em construcao" } |
| Response |
|---|
| { "id": "a0S1J00000At9b3UAB", "success": true, "errors": [] } |
Atualizar Documento do contrato:
Método :PATCH
URI com ID salesforce:https://{{dominio}}/services/data/{{versao}}/sobjects/snap_mall__documento_contrato__c/ (Id do registro salesforce)
Descrição:
Método de atualização de um Documento do contrato(snap_mall__documento_contrato__c) de qualquer tipo, informando no body apenas os campos que se deseja atualizar.
Request |
|---|
| { "snap_mall__situacao__c":"Anexado", "snap_mall__pendencia__c":"", "snap_mall__observacao__c":"Documento feito" } |
| Response |
|---|
Response em caso de sucesso da atualização retornará vazio.
Deletar Documento do contrato:
Método : DELETE
URI com ID salesforce:https://{{dominio}}/services/data/{{versao}}/sobjects/snap_mall__documento_contrato__c/ (Id do registro salesforce)
Descrição: Método de deleção de um Documento do contrato(snap_mall__documento_contrato__c) de qualquer tipo.
Request |
|---|
Body de deleção é vazio.
Response |
|---|
Response de deleção retorna vazio.