交易栏
交易栏
该应用程序显示在右侧的交易卡位置,以及本地小部件。
示例清单
“位置”:{
“卖出”:{
“deal_card”:“资产/ iframe.html”
}
},
以下对象在此位置可用:
事件
除了核心事件,以下事件可用于交易侧栏位置的应用程序:
还可以通过添加后缀侦听Deal对象的任何对象或属性上的更改.changed
它的路径。类绑定的任何事件处理程序.changed
事件接收一个对象,该对象具有已更改的属性的名称、它的前一个值和它的新值。例子:
客户端.在(“deal.creator.changed”,(数据)=>{
控制台.日志(数据);// {propertyName, oldValue, newValue}
});
看到使用框架事件.
deal.notes.added
在交易中添加注释时触发。绑定的任何事件处理程序deal.notes.added
接收note对象。
例子:
客户端.在(“deal.notes.added”,(请注意)=>{
控制台.日志(请注意);//注意对象
/ /例如:
/ / {
// id: 32661;
// "creator_id": 42616,
// resource_type: "sales_account";
// "resource_id": 29732437,
// "content": "呼叫他们,但没有回应",
// "created_at": "2019-10-01T09:00:21Z",
// "updated_at": "2019-10-01T09:00:21Z"
/ /}
});
deal.tasks.added
当任务被添加到当前选项卡中的事务时触发。绑定的任何事件处理程序deal.tasks.added
接收任务对象。
例子:
客户端.在(“deal.tasks.added”,(任务)=>{
控制台.日志(任务);//任务对象
/ /例如:
/ / {
// id: 32661;
// "creator_id": 42616,
// "owner_id": 42616,
// resource_type: "sales_account";
// "completed": false;
// "completed_at": null,
// "due_date": "2020-01-14T00:00:00Z",
// " expired ": false;
// "remind_at": null,
// "resource_id": 29732437,
// "content": "安排会议";
// "created_at": "2019-10-01T09:00:21Z",
// "updated_at": "2019-10-01T09:00:21Z"
/ /}
});
deal.tasks.completed
当当前交易的任务在当前选项卡中被标记为已完成时触发。绑定的任何事件处理程序deal.tasks.completed
接收任务对象。
例子:
客户端.在(“deal.tasks.completed”,(任务)=>{
控制台.日志(任务);//任务对象
/ /例如:
/ / {
// id: 32661;
// "creator_id": 42616,
// "owner_id": 42616,
// resource_type: "sales_account";
// "completed": true;
// "completed_at": "2019-12-14T09:00:11Z",
// "due_date": "2020-01-14T00:00:00Z",
// " expired ": false;
// "remind_at": null,
// "resource_id": 29732437,
// "content": "安排会议";
// "created_at": "2019-10-01T09:00:21Z",
// "updated_at": "2019-10-01T09:00:21Z"
/ /}
});
交易对象
Deals API提供了一个简单的接口来管理交易。每个交易都可以有多个关联的联系人,每个联系人都有不同的角色。
您可以为交易分配任意数量的标记和自定义字段。标签不需要存在就可以分配——它们可以在创建或更新交易时创建。
的组织
当您将交易与属于公司的主要联系人关联时自动设置。
交易
检索交易
对象及其一些属性。
得到
客户端.得到(“协议”)
返回
{
“协议”:{
“id”:4,
“名称”:“网站设计”,
“价值”:“1000.50”,
“货币”:“美元”,
“热”:真正的,
“lastStageChangeAt”:“2014 - 09 - 27 t16:32:56z”,
“dropboxEmail”:”(电子邮件保护)”,
“estimatedCloseDate”:“2015-06-19”,
“customizedWinLikelihood”:15,
“标签”:(“重要”],
“createdAt”:“2014 - 09 - 27 t16:32:56z”,
“updatedAt”:“2014 - 09 - 28 - t16:32:56z”
}
}
属性
- deal.contact(object)
- deal.contact.address(对象)
- deal.contact.address.city(财产)
- deal.contact.address.country(财产)
- deal.contact.address.line1(property)
- deal.contact.address.postalCode(财产)
- deal.contact.address.state(财产)
- deal.contact.billingAddress(对象)
- deal.contact.contact(对象)
- deal.contact.createdAt(财产)
- deal.contact.creator(对象)
- deal.contact.customFields(财产)
- deal.contact.customerStatus(财产)
- deal.contact.description(财产)
- deal.contact.email(财产)
- deal.contact.facebook(财产)
- deal.contact.fax(财产)
- deal.contact.firstName(财产)
- deal.contact.id(财产)
- deal.contact.industry(财产)
- deal.contact.isOrganization(财产)
- deal.contact.lastName(财产)
- deal.contact.linkedin(财产)
- deal.contact.mobile(财产)
- deal.contact.name(财产)
- deal.contact.owner(对象)
- deal.contact.parentOrganization(对象)
- deal.contact.phone(财产)
- deal.contact.prospectStatus(财产)
- deal.contact.shippingAddress(对象)
- deal.contact.skype(财产)
- deal.contact.tags(财产)
- deal.contact.title(财产)
- deal.contact.twitter(财产)
- deal.contact.updatedAt(财产)
- deal.contact.website(财产)
- deal.createdAt(property)
- deal.creator(object)
- deal.creator.id(财产)
- deal.currency(property)
- deal.customFields(property)
- deal.customizedWinLikelihood(property)
- deal.dropboxEmail(property)
- deal.estimatedCloseDate(财产)
- deal.hot(property)
- deal.id(property)
- deal.lastStageChangeAt(property)
- deal.lastStageChangeBy(object)
- deal.lossReason(property)
- deal.lossReason.id(财产)
- deal.name(财产)
- deal.notes(object)
- deal.organization(对象)
- deal.owner(object)
- deal.source(object)
- deal.source.id(财产)
- deal.stage(property)
- deal.stage.id(财产)
- deal.tags(property)
- deal.tasks(object)
- deal.unqualifiedReason(property)
- deal.unqualifiedReason.id(财产)
- deal.updatedAt(property)
- deal.value(property)
行动
deal.id
交易的唯一标识符。
得到
客户端.得到(“deal.id”)
返回
{
“deal.id”:4
}
deal.creator
创建交易的用户。
得到
客户端.得到(“deal.creator”)
返回
{
“deal.creator”:{
“id”:8
}
}
deal.creator.id
用户的唯一标识符。
得到
客户端.得到(“deal.creator.id”)
返回
{
“deal.creator.id”:8
}
deal.owner
当前分配给该交易的用户。
得到
客户端.得到(“deal.owner”)
看到用户对象对于返回的属性(deal.owner。*
).
deal.name
交易的名称。
得到
客户端.得到(“deal.name”)
返回
{
“deal.name”:“网站设计”
}
deal.value
属性中指定的货币的交易的值货币
字段。
得到
客户端.得到(“deal.value”)
返回
{
“deal.value”:“1000.50”
}
deal.currency
交易的货币,以3个字符的货币代码(ISO4217)格式指定。
得到
客户端.得到(“deal.currency”)
返回
{
“deal.currency”:“美元”
}
deal.hot
不管交易是否火爆。
得到
客户端.得到(“deal.hot”)
返回
{
“deal.hot”:真正的
}
deal.stage
交易目前处于筹备阶段。
得到
客户端.得到(“deal.stage”)
返回
{
“deal.stage”:{
“id”:1
}
}
deal.stage.id
交易当前阶段的唯一标识符。
得到
客户端.得到(“deal.stage.id”)
返回
{
“deal.stage.id”:1
}
deal.lastStageChangeAt
交易进入当前阶段的日期和时间(UTC, ISO8601格式)。
得到
客户端.得到(“deal.lastStageChangeAt”)
返回
{
“deal.lastStageChangeAt”:“2014 - 09 - 27 t16:32:56z”
}
deal.lastStageChangeBy
将交易移动到当前阶段的用户。
得到
客户端.得到(“deal.lastStageChangeBy”)
看到用户对象对于返回的属性(deal.lastStageChangeBy。*
).
deal.source
交易的来源。
得到
客户端.得到(“deal.source”)
返回
{
“deal.source”:{
“id”:10
}
}
deal.source.id
源的唯一标识符。
得到
客户端.得到(“deal.source.id”)
返回
{
“deal.source.id”:10
}
deal.lossReason
交易失败的原因。
得到
客户端.得到(“deal.lossReason”)
返回
{
“deal.lossReason”:{
“id”:20.
}
}
deal.lossReason.id
丢失原因唯一标识符。
得到
客户端.得到(“deal.lossReason.id”)
返回
{
“deal.lossReason.id”:20.
}
deal.unqualifiedReason
这笔交易不合格的原因。
得到
客户端.得到(“deal.unqualifiedReason”)
返回
{
“deal.unqualifiedReason”:{
“id”:32
}
}
deal.unqualifiedReason.id
不合格原因的唯一标识符。
得到
客户端.得到(“deal.unqualifiedReason.id”)
返回
{
“deal.unqualifiedReason.id”:32
}
deal.dropboxEmail
Dropbox的邮件与这笔交易有关。
得到
客户端.得到(“deal.dropboxEmail”)
返回
{
“deal.dropboxEmail”:”(电子邮件保护)”
}
deal.contact
主要接触。
得到
客户端.得到(“deal.contact”)
返回
{
“deal.contact”:{
“id”:4,
“isOrganization”:假,
“名称”:“设计服务公司”,
“firstName”:“马克”,
“姓”:“约翰逊”,
“customerStatus”:“当前”,
“prospectStatus”:“没有”,
“标题”:“首席执行官”,
“描述”:“我是通过汤姆认识他的。”,
“行业”:“设计服务”,
“网站”:“www.designservices.com”,
“电子邮件”:”(电子邮件保护)”,
“电话”:“508-778-6516”,
“移动”:“508-778-6516”,
“传真”:“+ 44-208-1234567”,
“推特”:“mjohnson”,
“facebook”:“mjohnson”,
“linkedin”:“mjohnson”,
“skype”:“mjohnson”,
“地址”:零,
“billingAddress”:零,
“shippingAddress”:零,
“标签”:(“重要”],
“createdAt”:“2014 - 09 - 27 t16:32:56z”,
“updatedAt”:“2014 - 09 - 28 - t16:32:56z”
}
}
deal.contact.id
联系人的唯一标识。
得到
客户端.得到(“deal.contact.id”)
返回
{
“deal.contact.id”:4
}
deal.contact.creator
创建联系人的用户。
得到
客户端.得到(“deal.contact.creator”)
看到用户对象对于返回的属性(deal.contact.creator。*
).
deal.contact.owner
联系人当前被分配的用户。
得到
客户端.得到(“deal.contact.owner”)
看到用户对象对于返回的属性(deal.contact.owner。*
).
deal.contact.isOrganization
无论这个联系人是指组织还是个人。该值只能在创建时设置,后续不可修改。默认值为假
.
得到
客户端.得到(“deal.contact.isOrganization”)
返回
{
“deal.contact.isOrganization”:假
}
deal.contact.contact
联系人所属的组织。只有联系人是个人时才设置该字段。
得到
客户端.得到(“deal.contact.contact”)
看到联系对象对于返回的属性(deal.contact.contact。*
).
deal.contact.parentOrganization
作为该组织的上级的组织联系人。只有当联系人是组织并且有父级时,才设置该字段。
得到
客户端.得到(“deal.contact.parentOrganization”)
看到联系对象对于返回的属性(deal.contact.parentOrganization。*
).
deal.contact.name
联系人姓名。仅当联系人是组织时才需要。
得到
客户端.得到(“deal.contact.name”)
返回
{
“deal.contact.name”:“设计服务公司”
}
deal.contact.firstName
联系人的名字。
得到
客户端.得到(“deal.contact.firstName”)
返回
{
“deal.contact.firstName”:“马克”
}
deal.contact.lastName
联系人的姓。只有当联系人是个人时才需要。
得到
客户端.得到(“deal.contact.lastName”)
返回
{
“deal.contact.lastName”:“约翰逊”
}
deal.contact.customerStatus
联系人的客户状态。状态为none, current, past。
得到
客户端.得到(“deal.contact.customerStatus”)
返回
{
“deal.contact.customerStatus”:“当前”
}
deal.contact.prospectStatus
联系人的前景状态。状态为none、current和lost。
得到
客户端.得到(“deal.contact.prospectStatus”)
返回
{
“deal.contact.prospectStatus”:“没有”
}
deal.contact.title
联系人的职位。
得到
客户端.得到(“deal.contact.title”)
返回
{
“deal.contact.title”:“首席执行官”
}
deal.contact.description
联系人的描述。
得到
客户端.得到(“deal.contact.description”)
返回
{
“deal.contact.description”:“我是通过汤姆认识他的。”
}
deal.contact.industry
联系人的行业。
得到
客户端.得到(“deal.contact.industry”)
返回
{
“deal.contact.industry”:“设计服务”
}
deal.contact.website
联系人的网站地址。
得到
客户端.得到(“deal.contact.website”)
返回
{
“deal.contact.website”:“www.designservices.com”
}
deal.contact.email
联系人的电子邮件地址。
得到
客户端.得到(“deal.contact.email”)
返回
{
“deal.contact.email”:”(电子邮件保护)”
}
deal.contact.phone
联系人的电话号码。
得到
客户端.得到(“deal.contact.phone”)
返回
{
“deal.contact.phone”:“508-778-6516”
}
deal.contact.mobile
联系人的手机号码。
得到
客户端.得到(“deal.contact.mobile”)
返回
{
“deal.contact.mobile”:“508-778-6516”
}
deal.contact.fax
联系人的传真号码。
得到
客户端.得到(“deal.contact.fax”)
返回
{
“deal.contact.fax”:“+ 44-208-1234567”
}
deal.contact.twitter
联系人的Twitter帐号。
得到
客户端.得到(“deal.contact.twitter”)
返回
{
“deal.contact.twitter”:“mjohnson”
}
deal.contact.facebook
联系人的Facebook昵称。
得到
客户端.得到(“deal.contact.facebook”)
返回
{
“deal.contact.facebook”:“mjohnson”
}
deal.contact.linkedin
联系人的LinkedIn昵称。
得到
客户端.得到(“deal.contact.linkedin”)
返回
{
“deal.contact.linkedin”:“mjohnson”
}
deal.contact.skype
联系人的Skype昵称。
得到
客户端.得到(“deal.contact.skype”)
返回
{
“deal.contact.skype”:“mjohnson”
}
deal.contact.address
联系人的地址。
得到
客户端.得到(“deal.contact.address”)
返回
{
“deal.contact.address”:{
“line1”:“史密斯街2726号”,
“城市”:“海恩尼斯”,
“邮政编码”:“02601”,
“状态”:“马”,
“国家”:“我们”
}
}
deal.contact.address.line1
地址的第一行。例如:号码和街道名称。
得到
客户端.得到(“deal.contact.address.line1”)
返回
{
“deal.contact.address.line1”:“史密斯街2726号”
}
deal.contact.address.city
城市的名字。
得到
客户端.得到(“deal.contact.address.city”)
返回
{
“deal.contact.address.city”:“海恩尼斯”
}
deal.contact.address.postalCode
邮政编码或同等学历。
得到
客户端.得到(“deal.contact.address.postalCode”)
返回
{
“deal.contact.address.postalCode”:“02601”
}
deal.contact.address.state
国家的名字。
得到
客户端.得到(“deal.contact.address.state”)
返回
{
“deal.contact.address.state”:“马”
}
deal.contact.address.country
国家的名字。
得到
客户端.得到(“deal.contact.address.country”)
返回
{
“deal.contact.address.country”:“我们”
}
deal.contact.billingAddress
客户的账单地址。仅适用于customerStatus
或prospectStatus
不是没有一个
.
得到
客户端.得到(“deal.contact.billingAddress”)
看到Address对象对于返回的属性(deal.contact.billingAddress。*
).
deal.contact.shippingAddress
客户的账单地址。仅适用于customerStatus
或prospectStatus
不是没有一个
.
得到
客户端.得到(“deal.contact.shippingAddress”)
看到Address对象对于返回的属性(deal.contact.shippingAddress。*
).
deal.contact.tags
联系人的标签数组。
得到
客户端.得到(“deal.contact.tags”)
返回
{
“deal.contact.tags”:(“重要”]
}
deal.contact.customFields
自定义字段是附加到联系人的键值对。
得到
客户端.得到(“deal.contact.customFields”)
看到自定义字段对象对于返回的属性(deal.contact.customFields。*
).
deal.contact.customFields:字段名
检索自定义字段的值。将自定义字段名添加到请求路径的冒号后面。
得到
客户端.得到(“deal.contact。customFields:我的自定义字段名)
retuns
{
“deal.contact。customFields:我的自定义字段名”:“我的价值”
}
看到自定义字段在Sell REST API文档中查找可能的返回类型。
deal.contact.createdAt
联系人的创建日期和时间(UTC, ISO8601格式)。
得到
客户端.得到(“deal.contact.createdAt”)
返回
{
“deal.contact.createdAt”:“2014 - 09 - 27 t16:32:56z”
}
deal.contact.updatedAt
联系人的最后更新日期和时间(UTC, ISO8601格式)。
得到
客户端.得到(“deal.contact.updatedAt”)
返回
{
“deal.contact.updatedAt”:“2014 - 09 - 28 - t16:32:56z”
}
deal.organization
相关的组织。
得到
客户端.得到(“deal.organization”)
看到联系对象对于返回的属性(deal.organization。*
).
deal.estimatedCloseDate
预计交易完成日期。
得到
客户端.得到(“deal.estimatedCloseDate”)
返回
{
“deal.estimatedCloseDate”:“2015-06-19”
}
deal.customizedWinLikelihood
用户提供的获胜概率值范围为0-100。
得到
客户端.得到(“deal.customizedWinLikelihood”)
返回
{
“deal.customizedWinLikelihood”:15
}
deal.tags
交易的标签数组。
得到
客户端.得到(“deal.tags”)
返回
{
“deal.tags”:(“重要”]
}
deal.customFields
自定义字段是附加到交易的键值对。
得到
客户端.得到(“deal.customFields”)
返回
{
“deal.customFields”:(的最后一个位置,“目前的供应商”,'我的自定义字段名']
}
deal.customFields:字段名
检索自定义字段的值。将自定义字段名添加到请求路径的冒号后面。
得到
客户端.得到(的交易。customFields:我的自定义字段名)
retuns
{
”交易。customFields:我的自定义字段名”:“我的价值”
}
看到自定义字段在Sell REST API文档中查找可能的返回类型。
deal.createdAt
交易的创建日期和时间(UTC, ISO8601格式)。
得到
客户端.得到(“deal.createdAt”)
返回
{
“deal.createdAt”:“2014 - 09 - 27 t16:32:56z”
}
deal.updatedAt
交易的最后更新日期和时间(UTC, ISO8601格式)。
得到
客户端.得到(“deal.updatedAt”)
返回
{
“deal.updatedAt”:“2014 - 09 - 28 - t16:32:56z”
}
deal.notes
deal.notes.create
为交易创建一个备注。
调用
客户端.调用(“deal.notes.create”,“叫他们,但没有回答。”);
论点
- 备注内容(字符串)
返回
{
“deal.notes.create”:{
“id”:32661,
“creator_id”:42616,
“resource_type”:“sales_account”,
“resource_id”:29732437,
“内容”:"呼唤他们,却没有回应",
“created_at”:“2019 - 10 - 01 - t09:00:21z”,
“updated_at”:“2019 - 10 - 01 - t09:00:21z”
}
}
deal.tasks
deal.tasks.create
为交易创建一个任务。
调用
客户端.调用(“deal.tasks.create”,“安排会议”,“2020-01-14”);
参数
- 任务的内容(字符串)
- 任务的截止日期(字符串)
返回
{
“deal.tasks.create”:{
“id”:32661,
“creator_id”:42616,
“owner_id”:42616,
“resource_type”:“sales_account”,
“完成”:假,
“completed_at”:零,
“due_date”:“2020 - 01 - 14 t00:00:00z”,
“过期”:假,
“remind_at”:零,
“resource_id”:29732437,
“内容”:“安排会议”,
“created_at”:“2019 - 10 - 01 - t09:00:21z”,
“updated_at”:“2019 - 10 - 01 - t09:00:21z”
}
}