根据类型过滤信封 [英] Filtering Envelopes based on a type

问题描述

我遇到一种情况，希望能够根据类型区分信封。例如，我要提供报价和发票，两者都可以发送给同一个人，因此我想知道是否存在一种方法来检查某种可以区分两者的字段。目前，我相当粗略地处理API结果并检查文档类型中的 quote，我想要一个更可靠的解决方案

I have a situation where I want to be able to differentiate between envelopes based on a 'type'. For example, I'll have quotes and invoices, both of these can be sent to the same person so I'd like to know if there's a way of checking some sort of field that could differentiate the two. Currently I'm rather crudely post processing the API results and checking for 'quote' in the document type and I'd like a rather more reliable solution

谢谢，
Oliver

thanks, Oliver

推荐答案

您可以使用信封自定义字段 aka 文档标签，用于指定信封的其他元数据。

You can use Envelope Custom Fields aka Document labels to specify additional metadata for an envelope.

信封自定义字段（也称为文档标签）可用于您帐户的信封可记录有关信封的信息，帮助搜索信封并跟踪信息。信封收件人看不到信封自定义字段。

Envelope Custom fields aka Document labels can be used in the envelopes for your account to record information about the envelope, help search for envelopes and track information. The envelope custom fields are not seen by the envelope recipients.

---

DocuSign Web 发送工具将信封自定义字段称为文档标签。您可以在帐户上将文档标签配置为管理员。请参见此处

一旦在帐户级别配置了文档标签，就可以为通过Web发送工具发送的每个信封提供标签值。请参见此处

Once the Document labels are configured at the account level, you can provide label values for each envelope you send through the web sending tool. See instructions here

另一个选择是使用API​​指定信封自定义字段。这是一个示例 createEnvelope api请求，该请求指定了与信封

The other option is to specify Envelope Custom fields using the API. Here is a sample createEnvelope api request that specifies custom Fields associated with the envelope

{
    "emailSubject": "Envelope with custom fields",
    "status": "sent",
    "customFields": {
        "listCustomFields": [
            {
                "listItems": [
                    "sample string 1"
                ],
                "name": "myListField",
                "required": "true",
                "show": "true",
                "value": "MyListValue"
            }
        ],
        "textCustomFields": [
            {
                "name": "MyOwnTextField",
                "required": "true",
                "show": "true",
                "value": "MyValue"
            }
        ]
    },
    "recipients": {
        "signers": [
            {
                "recipientId": 1,
                "email": "[e-mail]",
                "name": "kay smith",
                "routingOrder": "1"
            }
        ]
    },
    "documents": [
        {
            "documentId": "1",
            "name": "Agreement",
            "fileExtension": "txt",
            "documentBase64": "RG9jIFRXTyBUV08gVFdP"
        }
    ]
}

这篇关于根据类型过滤信封的文章就介绍到这了，希望我们推荐的答案对大家有所帮助，也希望大家多多支持IT屋！