Loading
Secuencia de API de Salesforce Contracts de muestra

Secuencia de API de Salesforce Contracts de muestra

A continuación se muestra una secuencia de ejemplo de llamadas de API Salesforce Contracts, que cubre una ruta óptima para un ciclo de vida de contrato de extremo a extremo. El ciclo de vida comienza cuando crea un contrato y el contrato está en el estado borrador para la activación del contrato.

Secuencia de ejemplo de llamadas de API Salesforce Contracts.

Secuencia de API Escenario Tipo de método Ruta de API Descripción
1 Crear contrato POST <url de su dominio>/services/data/{versión de API}/connect/clm/contract

Para crear un contrato desde una oportunidad, un presupuesto, un pedido o cualquier otro objeto estándar o personalizado. Después de crear un contrato, está en estado borrador.

cuerpo de solicitud:

{
    "sourceObjectId":"{$SourceObjectId}",
   "templateName":"{$DocumentTemplateName}",
    "isAutoDocgenRequired":false
} 

Si el tipo de configuración Generar documento automáticamente al crear un contrato está establecido como verdadero, la aplicación genera automáticamente una versión de documento de contrato cuando se crea un contrato.

2 Obtener plantillas de documentos GET <url de su dominio>/services/data/{versión de API}/connect/clm/document-template?usageType=Contract_LifeCycle_Management&isActive=true&type=MicrosoftWord

Enumera todas las plantillas de documentos activas. De forma predeterminada, se enumeran las plantillas que cumplen estos criterios:

Tipo = "Micropalabra",

UsageType = "Contract_Lifecycle_Management",

IsActive = verdadero

Para obtener información sobre el filtrado personalizado, consulte Utilizar filtrado de plantillas de documentos personalizados para Salesforce Contracts.

3 Generar documento de contrato PATCH <url de su dominio>/services/data/{versión de API}/connect/clm/contract/{ContractId}/version-documento-contrato

Para generar una nueva versión de documento de contrato. El estado del contrato debe tener el estado borrador para generar una nueva versión del documento de contrato.

cuerpo de solicitud:

{
    "templateId":"<DocumentTemplateId>"
}
4 Registrar PATCH <su URL de dominio>/services/data/{versión de API}/connect/clm/contract-document-version/${Id. de versión de documento de contrato}/checkin Para registrar la versión más reciente del documento de contrato que está inactiva y bloqueada.Nota: Solo el usuario que generó el documento puede realizar el registro.
5 Bloqueo PATCH <su URL de dominio>/services/data/{versión de API}/connect/clm/contract-document-version/${Id. de versión de documento de contrato}/lock Para bloquear la versión actual del documento de contrato. Solo puede bloquear una versión de documento de contrato cuando el contrato está en estado borrador y la versión de documento de contrato está activa o registrada.
6 Desbloquear PATCH <su URL de dominio>/services/data/{versión de API}/connect/clm/contract-document-version/${Id. de versión de documento de contrato}/unlock Para desbloquear la versión actual del documento de contrato. Solo el usuario que bloqueó la versión de documento de contrato o un administrador del sistema puede desbloquear una versión de documento de contrato bloqueada.
7 Check Out Generar PATCH <su URL de dominio>/services/data/{versión de API}/connect/clm/contract-document-version/{Id. de versión de documento de contrato}/Checkout

Para generar una nueva versión de documento de contrato utilizando la misma plantilla o una plantilla diferente utilizando la acción de generación de salida.

cuerpo de solicitud:

{
    "templateId":"{$templateId}"
} 

Después de Check Out, debe ejecutar la API de Check In.

8 Enviar para aprobación (Ejecutar acción) PATCH <url de su dominio>/services/data/{versión de API}/connect/clm/contract/${contractid}

Para llamar a la acción de envío para aprobación utilizando la API Ejecutar acción. El extremo permanece igual; sin embargo, cada API tiene parámetros de solicitud diferentes.

{
    "actionApiName" : "submitForApproval"
}

El proceso de aprobación debe estar configurado.

9 Aprobar ND ND

Esta es una API de aprobación de Salesforce genérica. Para obtener más información, consulte https://developer.salesforce.com/docs/atlas.en-us.api_rest.meta/api_rest/dome_process_approvals_approve.htm.

10 Obtener documentos para eSign con contrato GET <url de su dominio>/services/data/{versión de API}/connect/e-sign/documents?sourceObjectId=${contractId}

Para ver la lista de documentos asociados con un contrato que desea enviar para firma electrónica.

Los detalles del documento son obligatorios para su envío para firma electrónica. Puede personalizar la lista de documentos utilizando una clase Apex personalizada. Los detalles de la clase Apex deben agregarse en la Configuración de firma electrónica.

11 Obtener destinatarios GET <url de su dominio>/services/data/{versión de API}/connect/e-sign/recipients?recipientSelector=ESignContactList&sourceObjectId={$contractId}

Para ver una lista de destinatarios de documentos.

Los detalles del destinatario son obligatorios para enviar para firma electrónica. Puede personalizar la lista de destinatarios utilizando una clase Apex personalizada. Los detalles de la clase Apex deben agregarse en la Configuración de firma electrónica.

12 Obtener configuración de notificación GET <url de su dominio>/services/data/{versión de API}/connect/e-sign/notification-settings?sourceObjectId={$contractId} Para ver la configuración de notificaciones de vencimiento y recordatorio.Nota: Los detalles de notificación son obligatorios para enviar para firma electrónica.
13 Obtener funciones de firmante GET <url de su dominio>/services/data/{versión de API}/connect/e-sign/signer-roles

Para ver la lista de firmantes que firman y agregan datos a campos de formulario en los documentos en el sobre.

Los detalles del firmante son obligatorios para enviar para firma electrónica.

14 Enviar para firma electrónica (Ejecutar acción) PATCH <url de su dominio>/services/data/{versión de API}/connect/clm/contract/${contractid}

Para activar una nueva transacción de DocuSign utilizando la API de Enviar sobre.

La acción api debe cubrir los siguientes parámetros:

{
  "actionApiName": "sendForESign",
  "actionData":
  {
  "requestBody": <Request Body for E-Signature>  }
}

Cuerpo de solicitud de muestra. Debe convertir los detalles de JSON en Cadena y agregarlos en el cuerpo de solicitud anterior.

{
    "vendor": "Docusign",
    "emailSettings": {
        "emailSubject": "<EMail Subject>",
        "emailBody": "<EMail Body>"
    },
    "documents": [{
        "fileExtension": "<Ex:docx>",
        "name": "<File name to be sent for ESign EX:Test.docx>",
        "sourceId": "<Document Content Id of the file to be sent for ESign>",
        "sourceType": "Content",
        "documentId": "1"
    }],
    "recipients": {
        "signers": [{
            "name": "<Signer Name>",
            "email": "abc@example.com", 
            "recipientId": "1",
            "routingNumber": 1,
            "recipientType": "signer",
            "recipientLocale": "EN",
            "signerRole": 1,
            "routingOrder": 1
        }],
         "inPersonSigners": [{
            "name": "<Host Name>",
            "email": "xyz@example.com", 
            "recipientId": "2",
            "routingNumber": 2,
            "parentSignerName":"<Name of the In Person Signer>",
            "recipientType": "inPersonSigner",
            "recipientLocale": "EN",
            "signerRole": 2,
            "routingOrder": 2
        }],
         "carbonCopies": [{
            "name": "<Carbon Copy Recipient Name>",
            "email": "test@example.com", 
            "recipientId": "3",
            "routingNumber": 2,
            "recipientType": "carbonCopy",
            "recipientLocale": "EN",
            "routingOrder": 2
        }]
    },
    "notificationSettings": {
        "useAccountDefaults": false,
        "reminders": {
            "reminderFrequency": "1",
            "reminderDelay": "2",
            "reminderEnabled": false
        },
        "expirations": {
            "expireWarn": "1",
            "expireAfter": "5",
            "expireEnabled": false
        }
    }
}

actionData es un JSON con cadena que contiene la configuración de documento, receta, firmante y notificación.

15 Actualizar estado de sobre PATCH <url de su dominio>/services/data/{versión de API}/connect/clm/contract/${contractid}

Para enviar una solicitud ad hoc a DocuSign para actualizar el estado del sobre. Una vez que el firmante haya firmado el documento, puede llamar a la API de actualización de sobre.

{
  "actionApiName": "updateEnvelopeStatus"
}
16

Activar contrato (Ejecutar acción)

PATCH <url de su dominio>/services/data/{versión de API}/connect/clm/contract/${contractid}

Para activar el contrato.

Utilice la API para activar el contrato.

{
    "actionApiName" : "activateContract"
}
17 Rescindir contrato PATCH <detalles de su organización>/services/data/{versión de API}/connect/clm/contract/${contractid}

Para rescindir el contrato.

{
    "actionApiName" : "terminateContract"
}

API adicionales

Escenario Tipo de método Ruta de API Descripción
Obtener lista de versiones de documentos de contratos GET <url de su dominio>/services/data/{versión de API}/connect/clm/contract/<contractid>/version-documento-contrato Para ver la lista de versión de documento de contrato que ya están disponibles en el contrato.
Obtener versión de documento SpecificContract GET <url de su dominio>/services/data/{versión de API}/connect/clm/contract/{ContractId}/contract-document-version?contractDocumentVersionId={ContractDocumentVersionId} Para ver una versión de documento de contrato específica que ya está disponible en el contrato.
 
Cargando
Salesforce Help | Article