Zoho Invoice Basic (独立发布者) (预览版)

自定义和创建专业发票,并为你的辛勤工作付费。 Zoho Invoice 是适用于易于使用且完全免费的小型企业的在线发票管理软件。

此连接器在以下产品和区域中可用:

服务 Class 区域
Copilot Studio 高级 除以下各项外的所有 Power Automate 区域
     - 美国政府 (GCC)
     - 美国政府 (GCC High)
     - 由世纪互联运营的中国云
     - 美国国防部(DoD)
逻辑应用程序 标准 除以下各项外的所有 逻辑应用区域
     - Azure 政府区域
     - Azure 中国区域
     - 美国国防部(DoD)
Power Apps 高级 除以下各项外的所有 Power Apps 区域
     - 美国政府 (GCC)
     - 美国政府 (GCC High)
     - 由世纪互联运营的中国云
     - 美国国防部(DoD)
Power Automate 高级 除以下各项外的所有 Power Automate 区域
     - 美国政府 (GCC)
     - 美国政府 (GCC High)
     - 由世纪互联运营的中国云
     - 美国国防部(DoD)
联系人​​
Name 特洛伊·泰勒
URL https://www.troystaylor.com
Email troy@troystaylor.com
连接器元数据
发布者 特洛伊·泰勒
网站 https://www.zoho.com/us/invoice/
隐私策略 https://www.zoho.com/privacy.html
类别 金融;销售和 CRM

创建连接

连接器支持以下身份验证类型:

默认 用于创建连接的参数。 所有区域 不可共享

违约

适用:所有区域

用于创建连接的参数。

这是不可共享的连接。 如果 Power App 与另一个用户共享,系统会提示其他用户显式创建新连接。

Name 类型 Description 必选
Zoho 组织 ID 字符串 此 API 的 Zoho 组织标识符 True
客户 ID 字符串 此 API 的客户端 ID True
客户端密码 securestring 此 API 的客户端密码 True

限制

名称 调用 续订期
每个连接的 API 调用数 100 60 秒

操作

创建发票

为客户创建发票。

创建联系人

创建新的联系人。

删除发票

删除现有发票。 无法删除已应用付款或信用额度的发票。

删除联系人

删除现有联系人。

更新发票

更新现有发票。 若要删除行项,只需将其从line_items列表中删除。

更新联系人

更新现有联系人。

获取发票

检索发票的详细信息

获取发票

检索具有分页的发票列表。

获取联系人

检索现有联系人的详细信息。

获取联系人

检索具有分页的所有联系人的列表。

创建发票

为客户创建发票。

参数

名称 密钥 必需 类型 说明
发送
send boolean

是否发送发票。

忽略自动编号生成
ignore_auto_number_generation boolean

是否忽略自动生成数字。

客户 ID
customer_id string

客户标识符。

联系人
contact_persons array of integer

联系人。

发票号
invoice_number string

发票编号。

引用编号
reference_number string

引用编号。

供应地点
place_of_supply string

供应地点。

增值税处理
vat_treatment string

增值税待遇。

GST 治疗
gst_treatment string

GST 治疗。

税收待遇
tax_treatment string

税收待遇。

FDAI 用法
cfdi_usage string

使用CFI。

GST 编号
gst_no string

GST 编号。

模板编号
template_id string

模板标识符。

日期
date string

日期。

付款条款
payment_terms integer

付款条款。

付款条款标签
payment_terms_label string

付款条款标签。

截止日期
due_date string

截止日期。

折扣
discount float

折扣。

是税前折扣
is_discount_before_tax boolean

折扣是否在税前。

折扣类型
discount_type string

折扣类型。

非独占税
is_inclusive_tax boolean

是否包括税收。

汇率
exchange_rate float

汇率。

定期发票 ID
recurring_invoice_id string

定期发票标识符。

发票估计 ID
invoiced_estimate_id string

发票估计标识符。

Salesperson 名称
salesperson_name string

销售人员名称。

标签
label string

标签。

价值
value float

值。

项目标识
project_id string

项目标识符。

ID
item_id string

项标识符。

项目标识
project_id string

项目标识符。

时间输入 ID
time_entry_ids array of integer

时间条目标识符。

费用 ID
expense_id string

费用标识符。

Name
name string

名称。

产品类型
product_type string

产品类型。

HSN 或 SAC
hsn_or_sac integer

HSN 或 SAC 编号。

SAT 项密钥代码
sat_item_key_code integer

SAT 项密钥代码。

单元密钥代码
unitkey_code string

单元键代码。

Description
description string

说明。

下单
item_order integer

项顺序。

费率
rate float

速率。

数量
quantity double

数量。

单位
unit string

单位。

折扣
discount float

折扣。

税务 ID
tax_id string

税务标识符。

TDS 税务 ID
tds_tax_id string

TDS 税务标识符。

免税 ID
tax_exemption_id string

免税标识符。

AvaTax 使用代码
avatax_use_code string

AvaTax 使用代码。

AvaTax 豁免 No
avatax_exempt_no string

AvaTax 豁免编号。

税务名称
tax_name string

税务名称。

税务类型
tax_type string

税类型。

税务百分比
tax_percentage float

税收百分比。

Total
item_total float

项总数。

配置
configured boolean

是否已配置。

其他字段
additional_field1 string

其他字段。

Name
gateway_name string

名称。

允许部分付款
allow_partial_payments boolean

是否允许部分付款。

自定义正文
custom_body string

自定义正文。

自定义主题
custom_subject string

自定义主题。

注释
notes string

备注。

术语
terms string

术语。

寄送费用
shipping_charge float

发货费用。

调整
adjustment float

调整。

调整说明
adjustment_description string

调整说明。

原因
reason string

原因。

税务机构 ID
tax_authority_id string

税务机构标识符。

免税 ID
tax_exemption_id string

免税标识符。

AvaTax 使用代码
avatax_use_code string

AvaTax 使用代码。

AvaTax 税务代码
avatax_tax_code string

AvaTax 税务代码。

AvaTax 豁免编号
avatax_exempt_no string

AvaTax 豁免编号。

返回

名称 路径 类型 说明
状态代码
code integer

状态代码。

状态消息
message string

状态消息。

ID
invoice.invoice_id string

发票标识符。

ACH 付款已启动
invoice.ach_payment_initiated boolean

ACH 付款是否已启动。

编号
invoice.invoice_number string

发票编号。

是预 GST
invoice.is_pre_gst boolean

是否为 GST 前。

供应地点
invoice.place_of_supply string

供应地点。

GST 编号
invoice.gst_no string

GST 编号。

GST 治疗
invoice.gst_treatment string

GST 治疗。

税收待遇
invoice.tax_treatment string

税收待遇。

FDAI 用法
invoice.cfdi_usage string

使用CFI。

VAT 处理
invoice.vat_treatment string

增值税待遇。

VAT 注册
invoice.vat_reg_no string

VAT 注册号。

日期
invoice.date string

日期。

状态
invoice.status string

状态。

付款条款
invoice.payment_terms integer

付款条款。

付款条款标签
invoice.payment_terms_label string

付款条款标签。

截止日期
invoice.due_date string

截止日期。

付款预期日期
invoice.payment_expected_date string

付款预期日期。

上次付款日期
invoice.last_payment_date string

上次付款日期。

引用编号
invoice.reference_number string

引用编号。

客户 ID
invoice.customer_id string

客户标识符。

客户名称
invoice.customer_name string

客户名称。

联系人
invoice.contact_persons array of string

联系人。

货币 ID
invoice.currency_id string

货币标识符。

货币代码
invoice.currency_code string

货币代码。

汇率
invoice.exchange_rate double

汇率。

折扣
invoice.discount double

折扣。

是税前折扣
invoice.is_discount_before_tax boolean

折扣是否在税前。

折扣类型
invoice.discount_type string

折扣类型。

非独占税
invoice.is_inclusive_tax boolean

是否包括税收。

定期发票 ID
invoice.recurring_invoice_id string

定期发票标识符。

由客户端查看
invoice.is_viewed_by_client boolean

客户端是否查看。

具有附件
invoice.has_attachment boolean

是否具有附件。

客户端查看时间
invoice.client_viewed_time string

客户端查看时间。

行项
invoice.line_items array of object
ID
invoice.line_items.line_item_id string

行项标识符。

ID
invoice.line_items.item_id string

项标识符。

项目标识
invoice.line_items.project_id string

项目标识符。

项目名称
invoice.line_items.project_name string

项目名称。

项目类型
invoice.line_items.item_type string

项目类型。

产品类型
invoice.line_items.product_type string

产品类型。

time_entry_ids
invoice.line_items.time_entry_ids array of integer

time_entry_ids

费用 ID
invoice.line_items.expense_id string

费用标识符。

费用收据名称
invoice.line_items.expense_receipt_name string

费用收据名称。

Name
invoice.line_items.name string

名称。

Description
invoice.line_items.description string

说明。

项顺序
invoice.line_items.item_order integer

项顺序。

BCY 费率
invoice.line_items.bcy_rate double

BCY 速率。

费率
invoice.line_items.rate double

速率。

数量
invoice.line_items.quantity double

数量。

单位
invoice.line_items.unit string

单位。

折扣金额
invoice.line_items.discount_amount double

折扣金额。

折扣
invoice.line_items.discount double

折扣。

ID
invoice.line_items.tax_id string

税务标识符。

TDS 税务 ID
invoice.line_items.tds_tax_id string

TDS 税务标识符。

Name
invoice.line_items.tax_name string

税务名称。

税务类型
invoice.line_items.tax_type string

税类型。

税务百分比
invoice.line_items.tax_percentage double

税收百分比。

项目总计
invoice.line_items.item_total double

项总数。

SAT 项密钥代码
invoice.line_items.sat_item_key_code integer

SAT 项密钥代码。

单元密钥代码
invoice.line_items.unitkey_code string

单元键代码。

寄送费用
invoice.shipping_charge double

发货费用。

调整
invoice.adjustment double

调整。

调整说明
invoice.adjustment_description string

调整说明。

小计
invoice.sub_total double

分类汇总。

税款总额
invoice.tax_total double

税款总额。

Total
invoice.total double

总计。

税款
invoice.taxes array of object
Name
invoice.taxes.tax_name string

税务名称。

金额
invoice.taxes.tax_amount double

税额。

已启用付款提醒
invoice.payment_reminder_enabled boolean

是否启用付款提醒。

付款
invoice.payment_made double

付款。

已应用的额度
invoice.credits_applied double

应用的信用额度。

扣缴税款
invoice.tax_amount_withheld double

扣缴的税额。

所有者权益
invoice.balance double

余额。

注销金额
invoice.write_off_amount double

注销金额。

允许部分付款
invoice.allow_partial_payments boolean

是否允许部分付款。

价格精度
invoice.price_precision integer

价格精度。

Gateway
invoice.payment_options.payment_gateways array of object
配置
invoice.payment_options.payment_gateways.configured boolean

是否已配置。

其他字段
invoice.payment_options.payment_gateways.additional_field1 string

其他字段。

Name
invoice.payment_options.payment_gateways.gateway_name string

网关名称。

已通过电子邮件发送
invoice.is_emailed boolean

是否已发送电子邮件。

已发送提醒
invoice.reminders_sent integer

发送的提醒数。

上次提醒发送日期
invoice.last_reminder_sent_date string

上次发送的提醒日期。

地址
invoice.billing_address.address string

地址。

City
invoice.billing_address.city string

城市。

State
invoice.billing_address.state string

省/市/自治区。

邮政编码
invoice.billing_address.zip string

邮政编码。

国家
invoice.billing_address.country string

国家/ 地区。

传真
invoice.billing_address.fax string

传真号。

地址
invoice.shipping_address.address string

地址。

City
invoice.shipping_address.city string

城市。

State
invoice.shipping_address.state string

省/市/自治区。

邮政编码
invoice.shipping_address.zip string

邮政编码。

国家
invoice.shipping_address.country string

国家/ 地区。

传真
invoice.shipping_address.fax string

传真号。

注释
invoice.notes string

备注。

术语
invoice.terms string

术语。

自定义域
invoice.custom_fields array of object
ID
invoice.custom_fields.customfield_id string

自定义字段标识符。

数据类型
invoice.custom_fields.data_type string

数据类型。

Index
invoice.custom_fields.index integer

索引号。

标签
invoice.custom_fields.label string

标签。

在 PDF 上显示
invoice.custom_fields.show_on_pdf boolean

是否在 PDF 上显示。

在所有 PDF 中显示
invoice.custom_fields.show_in_all_pdf boolean

是否在所有 PDF 中显示。

价值
invoice.custom_fields.value double

自定义字段值。

模板编号
invoice.template_id string

模板标识符。

模板名称
invoice.template_name string

模板名称。

创建时间
invoice.created_time string

创建的时间。

上次修改时间
invoice.last_modified_time string

上次修改时间。

附件名称
invoice.attachment_name string

附件名称。

可以在邮件中发送邮件
invoice.can_send_in_mail boolean

是否可以发送邮件。

销售人员 ID
invoice.salesperson_id string

销售人员标识符。

Salesperson 名称
invoice.salesperson_name string

销售人员的姓名。

URL
invoice.invoice_url string

发票 URL 地址。

创建联系人

创建新的联系人。

参数

名称 密钥 必需 类型 说明
联系人姓名
contact_name True string

联系人姓名。

公司名称
company_name string

公司名称。

付款条款
payment_terms integer

付款条款。

货币 ID
currency_id string

货币标识符。

网站
website string

网站。

价值
value string

自定义字段值。

Index
index integer

索引号。

注意
attention string

注意名称。

地址
address string

地址。

地址 2
street2 string

地址 2。

State
state_code string

状态缩写。

City
city string

城市。

State
state string

省/市/自治区。

邮政编码
zip string

邮政编码。

国家
country string

国家/ 地区。

传真
fax string

传真号。

电话
phone string

电话号码。

注意
attention string

注意名称。

地址
address string

地址。

地址 2
street2 string

地址 2。

State
state_code string

状态缩写。

City
city string

城市。

State
state string

省/市/自治区。

邮政编码
zip string

邮政编码。

国家
country string

国家/ 地区。

传真
fax string

传真号。

电话
phone string

电话号码。

称呼
salutation string

敬礼。

名字
first_name string

名。

姓氏
last_name string

姓。

Email
email string

电子邮件地址。

电话
phone string

电话号码。

手机
mobile string

移动电话号码。

是主要联系人
is_primary_contact boolean

是否是主要联系人。

发票模板 ID
invoice_template_id string

发票模板标识符。

发票模板名称
invoice_template_name string

发票模板名称。

估计模板 ID
estimate_template_id string

估计模板标识符。

估计模板名称
estimate_template_name string

估计模板名称。

信用说明模板 ID
creditnote_template_id string

信用说明模板标识符。

信用说明模板名称
creditnote_template_name string

信用说明模板名称。

发票电子邮件模板 ID
invoice_email_template_id string

发票电子邮件模板标识符。

发票电子邮件模板名称
invoice_email_template_name string

发票电子邮件模板名称。

估计电子邮件模板 ID
estimate_email_template_id string

估计电子邮件模板标识符。

估计电子邮件模板名称
estimate_email_template_name string

估计电子邮件模板名称。

信用说明电子邮件模板 ID
creditnote_email_template_id string

信用说明电子邮件模板标识符。

信用说明电子邮件模板名称
creditnote_email_template_name string

信用说明电子邮件模板名称。

语言代码
language_code string

语言代码。

注释
notes string

备注。

VAT 注册
vat_reg_no string

VAT 注册号。

税务注册
tax_reg_no string

税务登记号。

国家/地区代码
country_code string

国家/地区代码。

VAT 处理
vat_treatment string

VAT 处理类型。

税收待遇
tax_treatment string

税收待遇类型。

税制
tax_regime string

税收制度。

法定名称
legal_name string

法定名称。

已注册 TDS
is_tds_registered boolean

是否注册 TDS。

联系人位置
place_of_contact string

联系人的位置。

GST 编号
gst_no string

GST 编号。

GST 治疗
gst_treatment string

GST 处理类型。

税务机构名称
tax_authority_name string

税务机构名称。

免税代码
tax_exemption_code string

免税代码。

AvaTax 豁免
avatax_exempt_no string

AvaTax 豁免编号。

AvaTax 使用代码
avatax_use_code string

AvaTax 使用代码。

免税 ID
tax_exemption_id string

免税标识符。

税务机构 ID
tax_authority_id string

税务机构标识符。

税务 ID
tax_id string

税务标识符。

TDS 税务 ID
tds_tax_id string

TDS 税务标识符。

应纳税
is_taxable boolean

是否应纳税。

脸书
facebook string

Facebook 用户名。

推特
twitter string

Twitter 句柄。

返回

名称 路径 类型 说明
状态代码
code integer

状态代码。

状态消息
message string

状态消息。

触点 ID
contact.contact_id string

联系人标识符。

联系人姓名
contact.contact_name string

联系人姓名。

公司名称
contact.company_name string

公司名称。

具有事务
contact.has_transaction boolean

是否具有事务。

联系人类型
contact.contact_type string

联系人类型。

应纳税
contact.is_taxable boolean

是否应纳税。

税务 ID
contact.tax_id string

税务标识符。

TDS 税务 ID
contact.tds_tax_id string

TDS 税务标识符。

税务名称
contact.tax_name string

税务名称。

税务百分比
contact.tax_percentage integer

税收百分比。

税务机构 ID
contact.tax_authority_id string

税务机构标识符。

免税 ID
contact.tax_exemption_id string

免税标识符。

税务机构名称
contact.tax_authority_name string

税务机构名称。

免税代码
contact.tax_exemption_code string

免税代码。

联系人位置
contact.place_of_contact string

联系人的位置。

GST 编号
contact.gst_no string

GST 编号。

VAT 处理
contact.vat_treatment string

增值税待遇。

税收待遇
contact.tax_treatment string

税收待遇。

税制
contact.tax_regime string

税收制度。

法定名称
contact.legal_name string

法定名称。

已注册 TDS
contact.is_tds_registered boolean

是否注册 TSD。

GST 治疗
contact.gst_treatment string

GST 治疗。

与 Zoho CRM 链接
contact.is_linked_with_zohocrm boolean

是否与 Zoho CRM 链接。

网站
contact.website string

网站。

主要联系人 ID
contact.primary_contact_id string

主要联系人标识符。

付款条款
contact.payment_terms integer

付款条款。

付款条款标签
contact.payment_terms_label string

付款条款标签。

货币 ID
contact.currency_id string

货币标识符。

货币代码
contact.currency_code string

货币代码。

货币符号
contact.currency_symbol string

货币符号。

语言代码
contact.language_code string

语言代码。

未偿还应收金额
contact.outstanding_receivable_amount double

未偿还应收金额。

未偿还应收金额 BCY
contact.outstanding_receivable_amount_bcy double

BCY 未偿还应收金额。

未使用的信用额度应收金额
contact.unused_credits_receivable_amount double

未使用的信用额度应收金额。

未使用的信用额度应收金额 BCY
contact.unused_credits_receivable_amount_bcy double

BCY 未使用的应收信贷金额。

状态
contact.status string

状态。

已启用付款提醒
contact.payment_reminder_enabled boolean

是否启用付款提醒。

自定义域
contact.custom_fields array of object
价值
contact.custom_fields.value string

自定义字段值。

Index
contact.custom_fields.index integer

索引号。

标签
contact.custom_fields.label string

标签。

注意
contact.billing_address.attention string

注意名称。

地址
contact.billing_address.address string

地址。

街道
contact.billing_address.street2 string

街道地址。

省/直辖市/自治区代码
contact.billing_address.state_code string

状态代码。

City
contact.billing_address.city string

城市。

State
contact.billing_address.state string

省/市/自治区。

邮政编码
contact.billing_address.zip string

邮政编码。

国家
contact.billing_address.country string

国家/ 地区。

传真
contact.billing_address.fax string

传真号。

电话
contact.billing_address.phone string

电话号码。

注意
contact.shipping_address.attention string

注意名称。

地址
contact.shipping_address.address string

地址。

街道
contact.shipping_address.street2 string

街道地址。

省/直辖市/自治区代码
contact.shipping_address.state_code string

状态代码。

City
contact.shipping_address.city string

城市。

State
contact.shipping_address.state string

省/市/自治区。

邮政编码
contact.shipping_address.zip string

邮政编码。

国家
contact.shipping_address.country string

国家/ 地区。

传真
contact.shipping_address.fax string

传真号。

电话
contact.shipping_address.phone string

电话号码。

脸书
contact.facebook string

Facebook 帐户。

推特
contact.twitter string

Twitter 句柄。

联系人
contact.contact_persons array of object
称呼
contact.contact_persons.salutation string

敬礼。

名字
contact.contact_persons.first_name string

名。

姓氏
contact.contact_persons.last_name string

姓。

Email
contact.contact_persons.email string

电子邮件地址。

电话
contact.contact_persons.phone string

电话号码。

手机
contact.contact_persons.mobile string

移动电话号码。

是主要联系人
contact.contact_persons.is_primary_contact boolean

是否是主要联系人。

发票模板 ID
contact.default_templates.invoice_template_id string

发票模板标识符。

发票模板名称
contact.default_templates.invoice_template_name string

发票模板名称。

估计模板 ID
contact.default_templates.estimate_template_id string

估计模板标识符。

估计模板名称
contact.default_templates.estimate_template_name string

估计模板名称。

信用说明模板 ID
contact.default_templates.creditnote_template_id string

信用说明模板标识符。

信用说明模板名称
contact.default_templates.creditnote_template_name string

信用说明模板名称。

发票电子邮件模板 ID
contact.default_templates.invoice_email_template_id string

发票电子邮件模板标识符。

发票电子邮件模板名称
contact.default_templates.invoice_email_template_name string

发票电子邮件模板名称。

估计电子邮件模板 ID
contact.default_templates.estimate_email_template_id string

估计电子邮件模板标识符。

估计电子邮件模板名称
contact.default_templates.estimate_email_template_name string

估计电子邮件模板名称。

信用说明电子邮件模板 ID
contact.default_templates.creditnote_email_template_id string

信用说明电子邮件模板标识符。

信用说明电子邮件模板名称
contact.default_templates.creditnote_email_template_name string

信用说明电子邮件模板名称。

注释
contact.notes string

备注。

创建时间
contact.created_time string

创建的时间。

上次修改时间
contact.last_modified_time string

上次修改时间。

删除发票

删除现有发票。 无法删除已应用付款或信用额度的发票。

参数

名称 密钥 必需 类型 说明
发票标识符
invoice_id True string

发票标识符。

返回

名称 路径 类型 说明
状态代码
code integer

状态代码。

状态消息
message string

状态消息。

删除联系人

删除现有联系人。

参数

名称 密钥 必需 类型 说明
触点 ID
contact_id True string

联系人标识符。

返回

名称 路径 类型 说明
状态代码
code integer

状态代码。

状态消息
message string

状态消息。

更新发票

更新现有发票。 若要删除行项,只需将其从line_items列表中删除。

参数

名称 密钥 必需 类型 说明
发票标识符
invoice_id True string

发票标识符。

客户 ID
customer_id string

客户标识符。

联系人
contact_persons array of integer

联系人。

发票号
invoice_number string

发票编号。

引用编号
reference_number string

引用编号。

供应地点
place_of_supply string

供应地点。

增值税处理
vat_treatment string

增值税待遇。

GST 治疗
gst_treatment string

GST 治疗。

税收待遇
tax_treatment string

税收待遇。

FDAI 用法
cfdi_usage string

使用CFI。

GST 编号
gst_no string

GST 编号。

模板编号
template_id string

模板标识符。

日期
date string

日期。

付款条款
payment_terms integer

付款条款。

付款条款标签
payment_terms_label string

付款条款标签。

截止日期
due_date string

截止日期。

折扣
discount float

折扣。

是税前折扣
is_discount_before_tax boolean

折扣是否在税前。

折扣类型
discount_type string

折扣类型。

非独占税
is_inclusive_tax boolean

是否包括税收。

汇率
exchange_rate float

汇率。

定期发票 ID
recurring_invoice_id string

定期发票标识符。

发票估计 ID
invoiced_estimate_id string

发票估计标识符。

Salesperson 名称
salesperson_name string

销售人员名称。

标签
label string

标签。

价值
value float

值。

项目标识
project_id string

项目标识符。

ID
item_id string

项标识符。

项目标识
project_id string

项目标识符。

时间输入 ID
time_entry_ids array of integer

时间条目标识符。

费用 ID
expense_id string

费用标识符。

Name
name string

名称。

产品类型
product_type string

产品类型。

HSN 或 SAC
hsn_or_sac integer

HSN 或 SAC 编号。

SAT 项密钥代码
sat_item_key_code integer

SAT 项密钥代码。

单元密钥代码
unitkey_code string

单元键代码。

Description
description string

说明。

下单
item_order integer

项顺序。

费率
rate float

速率。

数量
quantity double

数量。

单位
unit string

单位。

折扣
discount float

折扣。

税务 ID
tax_id string

税务标识符。

TDS 税务 ID
tds_tax_id string

TDS 税务标识符。

免税 ID
tax_exemption_id string

免税标识符。

AvaTax 使用代码
avatax_use_code string

AvaTax 使用代码。

AvaTax 豁免 No
avatax_exempt_no string

AvaTax 豁免编号。

税务名称
tax_name string

税务名称。

税务类型
tax_type string

税类型。

税务百分比
tax_percentage float

税收百分比。

Total
item_total float

项总数。

配置
configured boolean

是否已配置。

其他字段
additional_field1 string

其他字段。

Name
gateway_name string

名称。

允许部分付款
allow_partial_payments boolean

是否允许部分付款。

自定义正文
custom_body string

自定义正文。

自定义主题
custom_subject string

自定义主题。

注释
notes string

备注。

术语
terms string

术语。

寄送费用
shipping_charge float

发货费用。

调整
adjustment float

调整。

调整说明
adjustment_description string

调整说明。

原因
reason string

原因。

税务机构 ID
tax_authority_id string

税务机构标识符。

免税 ID
tax_exemption_id string

免税标识符。

AvaTax 使用代码
avatax_use_code string

AvaTax 使用代码。

AvaTax 税务代码
avatax_tax_code string

AvaTax 税务代码。

AvaTax 豁免编号
avatax_exempt_no string

AvaTax 豁免编号。

返回

名称 路径 类型 说明
状态代码
code integer

状态代码。

状态消息
message string

状态消息。

ID
invoice.invoice_id string

发票标识符。

ACH 付款已启动
invoice.ach_payment_initiated boolean

ACH 付款是否已启动。

编号
invoice.invoice_number string

发票编号。

是预 GST
invoice.is_pre_gst boolean

是否为 GST 前。

供应地点
invoice.place_of_supply string

供应地点。

GST 编号
invoice.gst_no string

GST 编号。

GST 治疗
invoice.gst_treatment string

GST 治疗。

税收待遇
invoice.tax_treatment string

税收待遇。

FDAI 用法
invoice.cfdi_usage string

使用CFI。

VAT 处理
invoice.vat_treatment string

增值税待遇。

VAT 注册
invoice.vat_reg_no string

VAT 注册号。

日期
invoice.date string

日期。

状态
invoice.status string

状态。

付款条款
invoice.payment_terms integer

付款条款。

付款条款标签
invoice.payment_terms_label string

付款条款标签。

截止日期
invoice.due_date string

截止日期。

付款预期日期
invoice.payment_expected_date string

付款预期日期。

上次付款日期
invoice.last_payment_date string

上次付款日期。

引用编号
invoice.reference_number string

引用编号。

客户 ID
invoice.customer_id string

客户标识符。

客户名称
invoice.customer_name string

客户名称。

联系人
invoice.contact_persons array of string

联系人。

货币 ID
invoice.currency_id string

货币标识符。

货币代码
invoice.currency_code string

货币代码。

汇率
invoice.exchange_rate double

汇率。

折扣
invoice.discount double

折扣。

是税前折扣
invoice.is_discount_before_tax boolean

折扣是否在税前。

折扣类型
invoice.discount_type string

折扣类型。

非独占税
invoice.is_inclusive_tax boolean

是否包括税收。

定期发票 ID
invoice.recurring_invoice_id string

定期发票标识符。

由客户端查看
invoice.is_viewed_by_client boolean

客户端是否查看。

具有附件
invoice.has_attachment boolean

是否具有附件。

客户端查看时间
invoice.client_viewed_time string

客户端查看时间。

行项
invoice.line_items array of object
ID
invoice.line_items.line_item_id string

行项标识符。

ID
invoice.line_items.item_id string

项标识符。

项目标识
invoice.line_items.project_id string

项目标识符。

项目名称
invoice.line_items.project_name string

项目名称。

项目类型
invoice.line_items.item_type string

项目类型。

产品类型
invoice.line_items.product_type string

产品类型。

time_entry_ids
invoice.line_items.time_entry_ids array of integer

time_entry_ids

费用 ID
invoice.line_items.expense_id string

费用标识符。

费用收据名称
invoice.line_items.expense_receipt_name string

费用收据名称。

Name
invoice.line_items.name string

名称。

Description
invoice.line_items.description string

说明。

项顺序
invoice.line_items.item_order integer

项顺序。

BCY 费率
invoice.line_items.bcy_rate double

BCY 速率。

费率
invoice.line_items.rate double

速率。

数量
invoice.line_items.quantity double

数量。

单位
invoice.line_items.unit string

单位。

折扣金额
invoice.line_items.discount_amount double

折扣金额。

折扣
invoice.line_items.discount double

折扣。

ID
invoice.line_items.tax_id string

税务标识符。

TDS 税务 ID
invoice.line_items.tds_tax_id string

TDS 税务标识符。

Name
invoice.line_items.tax_name string

税务名称。

税务类型
invoice.line_items.tax_type string

税类型。

税务百分比
invoice.line_items.tax_percentage double

税收百分比。

项目总计
invoice.line_items.item_total double

项总数。

SAT 项密钥代码
invoice.line_items.sat_item_key_code integer

SAT 项密钥代码。

单元密钥代码
invoice.line_items.unitkey_code string

单元键代码。

寄送费用
invoice.shipping_charge double

发货费用。

调整
invoice.adjustment double

调整。

调整说明
invoice.adjustment_description string

调整说明。

小计
invoice.sub_total double

分类汇总。

税款总额
invoice.tax_total double

税款总额。

Total
invoice.total double

总计。

税款
invoice.taxes array of object
Name
invoice.taxes.tax_name string

税务名称。

金额
invoice.taxes.tax_amount double

税额。

已启用付款提醒
invoice.payment_reminder_enabled boolean

是否启用付款提醒。

付款
invoice.payment_made double

付款。

已应用的额度
invoice.credits_applied double

应用的信用额度。

扣缴税款
invoice.tax_amount_withheld double

扣缴的税额。

所有者权益
invoice.balance double

余额。

注销金额
invoice.write_off_amount double

注销金额。

允许部分付款
invoice.allow_partial_payments boolean

是否允许部分付款。

价格精度
invoice.price_precision integer

价格精度。

Gateway
invoice.payment_options.payment_gateways array of object
配置
invoice.payment_options.payment_gateways.configured boolean

是否已配置。

其他字段
invoice.payment_options.payment_gateways.additional_field1 string

其他字段。

Name
invoice.payment_options.payment_gateways.gateway_name string

网关名称。

已通过电子邮件发送
invoice.is_emailed boolean

是否已发送电子邮件。

已发送提醒
invoice.reminders_sent integer

发送的提醒数。

上次提醒发送日期
invoice.last_reminder_sent_date string

上次发送的提醒日期。

地址
invoice.billing_address.address string

地址。

City
invoice.billing_address.city string

城市。

State
invoice.billing_address.state string

省/市/自治区。

邮政编码
invoice.billing_address.zip string

邮政编码。

国家
invoice.billing_address.country string

国家/ 地区。

传真
invoice.billing_address.fax string

传真号。

地址
invoice.shipping_address.address string

地址。

City
invoice.shipping_address.city string

城市。

State
invoice.shipping_address.state string

省/市/自治区。

邮政编码
invoice.shipping_address.zip string

邮政编码。

国家
invoice.shipping_address.country string

国家/ 地区。

传真
invoice.shipping_address.fax string

传真号。

注释
invoice.notes string

备注。

术语
invoice.terms string

术语。

自定义域
invoice.custom_fields array of object
ID
invoice.custom_fields.customfield_id string

自定义字段标识符。

数据类型
invoice.custom_fields.data_type string

数据类型。

Index
invoice.custom_fields.index integer

索引号。

标签
invoice.custom_fields.label string

标签。

在 PDF 上显示
invoice.custom_fields.show_on_pdf boolean

是否在 PDF 上显示。

在所有 PDF 中显示
invoice.custom_fields.show_in_all_pdf boolean

是否在所有 PDF 中显示。

价值
invoice.custom_fields.value double

自定义字段值。

模板编号
invoice.template_id string

模板标识符。

模板名称
invoice.template_name string

模板名称。

创建时间
invoice.created_time string

创建的时间。

上次修改时间
invoice.last_modified_time string

上次修改时间。

附件名称
invoice.attachment_name string

附件名称。

可以在邮件中发送邮件
invoice.can_send_in_mail boolean

是否可以发送邮件。

销售人员 ID
invoice.salesperson_id string

销售人员标识符。

Salesperson 名称
invoice.salesperson_name string

销售人员的姓名。

URL
invoice.invoice_url string

发票 URL 地址。

更新联系人

更新现有联系人。

参数

名称 密钥 必需 类型 说明
触点 ID
contact_id True string

联系人标识符。

联系人姓名
contact_name True string

联系人姓名。

公司名称
company_name string

公司名称。

付款条款
payment_terms integer

付款条款。

货币 ID
currency_id string

货币标识符。

网站
website string

网站。

价值
value string

自定义字段值。

Index
index integer

索引号。

标签
label string

标签。

注意
attention string

注意名称。

地址
address string

地址。

地址 2
street2 string

地址 2。

State
state_code string

状态缩写。

City
city string

城市。

State
state string

省/市/自治区。

邮政编码
zip string

邮政编码。

国家
country string

国家/ 地区。

传真
fax string

传真号。

电话
phone string

电话号码。

注意
attention string

注意名称。

地址
address string

地址。

地址 2
street2 string

地址 2。

State
state_code string

状态缩写。

City
city string

城市。

State
state string

省/市/自治区。

邮政编码
zip string

邮政编码。

国家
country string

国家/ 地区。

传真
fax string

传真号。

电话
phone string

电话号码。

称呼
salutation string

敬礼。

名字
first_name string

名。

姓氏
last_name string

姓。

Email
email string

电子邮件地址。

电话
phone string

电话号码。

手机
mobile string

移动电话号码。

是主要联系人
is_primary_contact boolean

是否是主要联系人。

发票模板 ID
invoice_template_id string

发票模板标识符。

发票模板名称
invoice_template_name string

发票模板名称。

估计模板 ID
estimate_template_id string

估计模板标识符。

估计模板名称
estimate_template_name string

估计模板名称。

信用说明模板 ID
creditnote_template_id string

信用说明模板标识符。

信用说明模板名称
creditnote_template_name string

信用说明模板名称。

发票电子邮件模板 ID
invoice_email_template_id string

发票电子邮件模板标识符。

发票电子邮件模板名称
invoice_email_template_name string

发票电子邮件模板名称。

估计电子邮件模板 ID
estimate_email_template_id string

估计电子邮件模板标识符。

估计电子邮件模板名称
estimate_email_template_name string

估计电子邮件模板名称。

信用说明电子邮件模板 ID
creditnote_email_template_id string

信用说明电子邮件模板标识符。

信用说明电子邮件模板名称
creditnote_email_template_name string

信用说明电子邮件模板名称。

语言代码
language_code string

语言代码。

注释
notes string

备注。

VAT 注册
vat_reg_no string

VAT 注册号。

税务注册
tax_reg_no string

税务登记号。

国家/地区代码
country_code string

国家/地区代码。

VAT 处理
vat_treatment string

VAT 处理类型。

税收待遇
tax_treatment string

税收待遇类型。

税制
tax_regime string

税收制度。

法定名称
legal_name string

法定名称。

已注册 TDS
is_tds_registered boolean

是否注册 TDS。

联系人位置
place_of_contact string

联系人的位置。

GST 编号
gst_no string

GST 编号。

GST 治疗
gst_treatment string

GST 处理类型。

税务机构名称
tax_authority_name string

税务机构名称。

免税代码
tax_exemption_code string

免税代码。

AvaTax 豁免
avatax_exempt_no string

AvaTax 豁免编号。

AvaTax 使用代码
avatax_use_code string

AvaTax 使用代码。

免税 ID
tax_exemption_id string

免税标识符。

税务机构 ID
tax_authority_id string

税务机构标识符。

税务 ID
tax_id string

税务标识符。

TDS 税务 ID
tds_tax_id string

TDS 税务标识符。

应纳税
is_taxable boolean

是否应纳税。

脸书
facebook string

Facebook 用户名。

推特
twitter string

Twitter 句柄。

返回

名称 路径 类型 说明
状态代码
code integer

状态代码。

状态消息
message string

状态消息。

触点 ID
contact.contact_id string

联系人标识符。

联系人姓名
contact.contact_name string

联系人姓名。

公司名称
contact.company_name string

公司名称。

具有事务
contact.has_transaction boolean

是否具有事务。

联系人类型
contact.contact_type string

联系人类型。

应纳税
contact.is_taxable boolean

是否应纳税。

税务 ID
contact.tax_id string

税务标识符。

TDS 税务 ID
contact.tds_tax_id string

TDS 税务标识符。

税务名称
contact.tax_name string

税务名称。

税务百分比
contact.tax_percentage integer

税收百分比。

税务机构 ID
contact.tax_authority_id string

税务机构标识符。

免税 ID
contact.tax_exemption_id string

免税标识符。

税务机构名称
contact.tax_authority_name string

税务机构名称。

免税代码
contact.tax_exemption_code string

免税代码。

联系人位置
contact.place_of_contact string

联系人的位置。

GST 编号
contact.gst_no string

GST 编号。

VAT 处理
contact.vat_treatment string

增值税待遇。

税收待遇
contact.tax_treatment string

税收待遇。

税制
contact.tax_regime string

税收制度。

法定名称
contact.legal_name string

法定名称。

已注册 TDS
contact.is_tds_registered boolean

是否注册 TSD。

GST 治疗
contact.gst_treatment string

GST 治疗。

与 Zoho CRM 链接
contact.is_linked_with_zohocrm boolean

是否与 Zoho CRM 链接。

网站
contact.website string

网站。

主要联系人 ID
contact.primary_contact_id string

主要联系人标识符。

付款条款
contact.payment_terms integer

付款条款。

付款条款标签
contact.payment_terms_label string

付款条款标签。

货币 ID
contact.currency_id string

货币标识符。

货币代码
contact.currency_code string

货币代码。

货币符号
contact.currency_symbol string

货币符号。

语言代码
contact.language_code string

语言代码。

未偿还应收金额
contact.outstanding_receivable_amount double

未偿还应收金额。

未偿还应收金额 BCY
contact.outstanding_receivable_amount_bcy double

BCY 未偿还应收金额。

未使用的信用额度应收金额
contact.unused_credits_receivable_amount double

未使用的信用额度应收金额。

未使用的信用额度应收金额 BCY
contact.unused_credits_receivable_amount_bcy double

BCY 未使用的应收信贷金额。

状态
contact.status string

状态。

已启用付款提醒
contact.payment_reminder_enabled boolean

是否启用付款提醒。

自定义域
contact.custom_fields array of object
价值
contact.custom_fields.value string

自定义字段值。

Index
contact.custom_fields.index integer

索引号。

标签
contact.custom_fields.label string

标签。

注意
contact.billing_address.attention string

注意名称。

地址
contact.billing_address.address string

地址。

街道
contact.billing_address.street2 string

街道地址。

省/直辖市/自治区代码
contact.billing_address.state_code string

状态代码。

City
contact.billing_address.city string

城市。

State
contact.billing_address.state string

省/市/自治区。

邮政编码
contact.billing_address.zip string

邮政编码。

国家
contact.billing_address.country string

国家/ 地区。

传真
contact.billing_address.fax string

传真号。

电话
contact.billing_address.phone string

电话号码。

注意
contact.shipping_address.attention string

注意名称。

地址
contact.shipping_address.address string

地址。

街道
contact.shipping_address.street2 string

街道地址。

省/直辖市/自治区代码
contact.shipping_address.state_code string

状态代码。

City
contact.shipping_address.city string

城市。

State
contact.shipping_address.state string

省/市/自治区。

邮政编码
contact.shipping_address.zip string

邮政编码。

国家
contact.shipping_address.country string

国家/ 地区。

传真
contact.shipping_address.fax string

传真号。

电话
contact.shipping_address.phone string

电话号码。

脸书
contact.facebook string

Facebook 帐户。

推特
contact.twitter string

Twitter 句柄。

联系人
contact.contact_persons array of object
称呼
contact.contact_persons.salutation string

敬礼。

名字
contact.contact_persons.first_name string

名。

姓氏
contact.contact_persons.last_name string

姓。

Email
contact.contact_persons.email string

电子邮件地址。

电话
contact.contact_persons.phone string

电话号码。

手机
contact.contact_persons.mobile string

移动电话号码。

是主要联系人
contact.contact_persons.is_primary_contact boolean

是否是主要联系人。

发票模板 ID
contact.default_templates.invoice_template_id string

发票模板标识符。

发票模板名称
contact.default_templates.invoice_template_name string

发票模板名称。

估计模板 ID
contact.default_templates.estimate_template_id string

估计模板标识符。

估计模板名称
contact.default_templates.estimate_template_name string

估计模板名称。

信用说明模板 ID
contact.default_templates.creditnote_template_id string

信用说明模板标识符。

信用说明模板名称
contact.default_templates.creditnote_template_name string

信用说明模板名称。

发票电子邮件模板 ID
contact.default_templates.invoice_email_template_id string

发票电子邮件模板标识符。

发票电子邮件模板名称
contact.default_templates.invoice_email_template_name string

发票电子邮件模板名称。

估计电子邮件模板 ID
contact.default_templates.estimate_email_template_id string

估计电子邮件模板标识符。

估计电子邮件模板名称
contact.default_templates.estimate_email_template_name string

估计电子邮件模板名称。

信用说明电子邮件模板 ID
contact.default_templates.creditnote_email_template_id string

信用说明电子邮件模板标识符。

信用说明电子邮件模板名称
contact.default_templates.creditnote_email_template_name string

信用说明电子邮件模板名称。

注释
contact.notes string

备注。

创建时间
contact.created_time string

创建的时间。

上次修改时间
contact.last_modified_time string

上次修改时间。

获取发票

检索发票的详细信息

参数

名称 密钥 必需 类型 说明
发票标识符
invoice_id True string

发票标识符。

返回

名称 路径 类型 说明
状态代码
code integer

状态代码。

状态消息
message string

状态消息。

ID
invoice.invoice_id string

发票标识符。

ACH 付款已启动
invoice.ach_payment_initiated boolean

ACH 付款是否已启动。

编号
invoice.invoice_number string

发票编号。

是预 GST
invoice.is_pre_gst boolean

是否为 GST 前。

供应地点
invoice.place_of_supply string

供应地点。

GST 编号
invoice.gst_no string

GST 编号。

GST 治疗
invoice.gst_treatment string

GST 治疗。

税收待遇
invoice.tax_treatment string

税收待遇。

FDAI 用法
invoice.cfdi_usage string

使用CFI。

VAT 处理
invoice.vat_treatment string

增值税待遇。

VAT 注册
invoice.vat_reg_no string

VAT 注册号。

日期
invoice.date string

日期。

状态
invoice.status string

状态。

付款条款
invoice.payment_terms integer

付款条款。

付款条款标签
invoice.payment_terms_label string

付款条款标签。

截止日期
invoice.due_date string

截止日期。

付款预期日期
invoice.payment_expected_date string

付款预期日期。

上次付款日期
invoice.last_payment_date string

上次付款日期。

引用编号
invoice.reference_number string

引用编号。

客户 ID
invoice.customer_id string

客户标识符。

客户名称
invoice.customer_name string

客户名称。

联系人
invoice.contact_persons array of string

联系人。

货币 ID
invoice.currency_id string

货币标识符。

货币代码
invoice.currency_code string

货币代码。

汇率
invoice.exchange_rate double

汇率。

折扣
invoice.discount double

折扣。

是税前折扣
invoice.is_discount_before_tax boolean

折扣是否在税前。

折扣类型
invoice.discount_type string

折扣类型。

非独占税
invoice.is_inclusive_tax boolean

是否包括税收。

定期发票 ID
invoice.recurring_invoice_id string

定期发票标识符。

由客户端查看
invoice.is_viewed_by_client boolean

客户端是否查看。

具有附件
invoice.has_attachment boolean

是否具有附件。

客户端查看时间
invoice.client_viewed_time string

客户端查看时间。

行项
invoice.line_items array of object
ID
invoice.line_items.line_item_id string

行项标识符。

ID
invoice.line_items.item_id string

项标识符。

项目标识
invoice.line_items.project_id string

项目标识符。

项目名称
invoice.line_items.project_name string

项目名称。

项目类型
invoice.line_items.item_type string

项目类型。

产品类型
invoice.line_items.product_type string

产品类型。

time_entry_ids
invoice.line_items.time_entry_ids array of integer

time_entry_ids

费用 ID
invoice.line_items.expense_id string

费用标识符。

费用收据名称
invoice.line_items.expense_receipt_name string

费用收据名称。

Name
invoice.line_items.name string

名称。

Description
invoice.line_items.description string

说明。

项顺序
invoice.line_items.item_order integer

项顺序。

BCY 费率
invoice.line_items.bcy_rate double

BCY 速率。

费率
invoice.line_items.rate double

速率。

数量
invoice.line_items.quantity double

数量。

单位
invoice.line_items.unit string

单位。

折扣金额
invoice.line_items.discount_amount double

折扣金额。

折扣
invoice.line_items.discount double

折扣。

ID
invoice.line_items.tax_id string

税务标识符。

TDS 税务 ID
invoice.line_items.tds_tax_id string

TDS 税务标识符。

Name
invoice.line_items.tax_name string

税务名称。

税务类型
invoice.line_items.tax_type string

税类型。

税务百分比
invoice.line_items.tax_percentage double

税收百分比。

项目总计
invoice.line_items.item_total double

项总数。

SAT 项密钥代码
invoice.line_items.sat_item_key_code integer

SAT 项密钥代码。

单元密钥代码
invoice.line_items.unitkey_code string

单元键代码。

寄送费用
invoice.shipping_charge double

发货费用。

调整
invoice.adjustment double

调整。

调整说明
invoice.adjustment_description string

调整说明。

小计
invoice.sub_total double

分类汇总。

税款总额
invoice.tax_total double

税款总额。

Total
invoice.total double

总计。

税款
invoice.taxes array of object
Name
invoice.taxes.tax_name string

税务名称。

金额
invoice.taxes.tax_amount double

税额。

已启用付款提醒
invoice.payment_reminder_enabled boolean

是否启用付款提醒。

付款
invoice.payment_made double

付款。

已应用的额度
invoice.credits_applied double

应用的信用额度。

扣缴税款
invoice.tax_amount_withheld double

扣缴的税额。

所有者权益
invoice.balance double

余额。

注销金额
invoice.write_off_amount double

注销金额。

允许部分付款
invoice.allow_partial_payments boolean

是否允许部分付款。

价格精度
invoice.price_precision integer

价格精度。

Gateway
invoice.payment_options.payment_gateways array of object
配置
invoice.payment_options.payment_gateways.configured boolean

是否已配置。

其他字段
invoice.payment_options.payment_gateways.additional_field1 string

其他字段。

Name
invoice.payment_options.payment_gateways.gateway_name string

网关名称。

已通过电子邮件发送
invoice.is_emailed boolean

是否已发送电子邮件。

已发送提醒
invoice.reminders_sent integer

发送的提醒数。

上次提醒发送日期
invoice.last_reminder_sent_date string

上次发送的提醒日期。

地址
invoice.billing_address.address string

地址。

City
invoice.billing_address.city string

城市。

State
invoice.billing_address.state string

省/市/自治区。

邮政编码
invoice.billing_address.zip string

邮政编码。

国家
invoice.billing_address.country string

国家/ 地区。

传真
invoice.billing_address.fax string

传真号。

地址
invoice.shipping_address.address string

地址。

City
invoice.shipping_address.city string

城市。

State
invoice.shipping_address.state string

省/市/自治区。

邮政编码
invoice.shipping_address.zip string

邮政编码。

国家
invoice.shipping_address.country string

国家/ 地区。

传真
invoice.shipping_address.fax string

传真号。

注释
invoice.notes string

备注。

术语
invoice.terms string

术语。

自定义域
invoice.custom_fields array of object
ID
invoice.custom_fields.customfield_id string

自定义字段标识符。

数据类型
invoice.custom_fields.data_type string

数据类型。

Index
invoice.custom_fields.index integer

索引号。

标签
invoice.custom_fields.label string

标签。

在 PDF 上显示
invoice.custom_fields.show_on_pdf boolean

是否在 PDF 上显示。

在所有 PDF 中显示
invoice.custom_fields.show_in_all_pdf boolean

是否在所有 PDF 中显示。

价值
invoice.custom_fields.value double

自定义字段值。

模板编号
invoice.template_id string

模板标识符。

模板名称
invoice.template_name string

模板名称。

创建时间
invoice.created_time string

创建的时间。

上次修改时间
invoice.last_modified_time string

上次修改时间。

附件名称
invoice.attachment_name string

附件名称。

可以在邮件中发送邮件
invoice.can_send_in_mail boolean

是否可以发送邮件。

销售人员 ID
invoice.salesperson_id string

销售人员标识符。

Salesperson 名称
invoice.salesperson_name string

销售人员的姓名。

URL
invoice.invoice_url string

发票 URL 地址。

获取发票

检索具有分页的发票列表。

参数

名称 密钥 必需 类型 说明
发票号
invoice_number string

发票编号。

项名称
item_name string

项目名称。

物料 ID
item_id string

项标识符。

项说明
item_description string

项说明。

引用编号
reference_number string

引用编号。

客户名称
customer_name string

客户名称。

定期发票 ID
recurring_invoice_id string

定期发票标识符。

Email
email string

电子邮件地址。

Total
total string

总计。

所有者权益
balance string

余额。

自定义域
custom_field string

自定义域。

日期
date string

日期。

截止日期
due_date string

截止日期。

状态
status string

状态。

自定义 ID
customer_id string

自定义标识符。

筛选依据
filter_by string

筛选器依据。

搜索文本
search_text string

搜索文本。

对列进行排序
sort_column string

排序列。

Zoho CRM 潜在 ID
zcrm_potential_id string

Zoho CRM 潜在标识符。

page integer

页码。

每页
per_page integer

每页码。

返回

名称 路径 类型 说明
状态代码
code integer

状态代码。

状态消息
message string

状态消息。

发票
invoices array of object
ID
invoices.invoice_id string

发票标识符。

ACH 付款已启动
invoices.ach_payment_initiated boolean

ACH 付款是否已启动。

编号
invoices.invoice_number string

发票编号。

是预 GST
invoices.is_pre_gst boolean

是否为 GST 前。

供应地点
invoices.place_of_supply string

供应地点。

GST 编号
invoices.gst_no string

GST 编号。

GST 治疗
invoices.gst_treatment string

GST 治疗。

税收待遇
invoices.tax_treatment string

税收待遇。

FDAI 用法
invoices.cfdi_usage string

使用CFI。

VAT 处理
invoices.vat_treatment string

增值税待遇。

VAT 注册
invoices.vat_reg_no string

VAT 注册号。

日期
invoices.date string

日期。

状态
invoices.status string

状态。

付款条款
invoices.payment_terms integer

付款条款。

付款条款标签
invoices.payment_terms_label string

付款条款标签。

截止日期
invoices.due_date string

截止日期。

付款预期日期
invoices.payment_expected_date string

付款预期日期。

上次付款日期
invoices.last_payment_date string

上次付款日期。

引用编号
invoices.reference_number string

引用编号。

客户 ID
invoices.customer_id string

客户标识符。

客户名称
invoices.customer_name string

客户名称。

联系人
invoices.contact_persons array of string

联系人。

货币 ID
invoices.currency_id string

货币标识符。

货币代码
invoices.currency_code string

货币代码。

汇率
invoices.exchange_rate double

汇率。

折扣
invoices.discount double

折扣。

是税前折扣
invoices.is_discount_before_tax boolean

折扣是否在税前。

折扣类型
invoices.discount_type string

折扣类型。

非独占税
invoices.is_inclusive_tax boolean

是否包括税收。

定期发票 ID
invoices.recurring_invoice_id string

定期发票标识符。

由客户端查看
invoices.is_viewed_by_client boolean

客户端是否查看。

具有附件
invoices.has_attachment boolean

是否具有附件。

客户端查看时间
invoices.client_viewed_time string

客户端查看时间。

行项
invoices.line_items array of object
ID
invoices.line_items.line_item_id string

行项标识符。

ID
invoices.line_items.item_id string

项标识符。

项目标识
invoices.line_items.project_id string

项目标识符。

项目名称
invoices.line_items.project_name string

项目名称。

项目类型
invoices.line_items.item_type string

项目类型。

产品类型
invoices.line_items.product_type string

产品类型。

time_entry_ids
invoices.line_items.time_entry_ids array of integer

time_entry_ids

费用 ID
invoices.line_items.expense_id string

费用标识符。

费用收据名称
invoices.line_items.expense_receipt_name string

费用收据名称。

Name
invoices.line_items.name string

名称。

Description
invoices.line_items.description string

说明。

项顺序
invoices.line_items.item_order integer

项顺序。

BCY 费率
invoices.line_items.bcy_rate double

BCY 速率。

费率
invoices.line_items.rate double

速率。

数量
invoices.line_items.quantity double

数量。

单位
invoices.line_items.unit string

单位。

折扣金额
invoices.line_items.discount_amount double

折扣金额。

折扣
invoices.line_items.discount double

折扣。

ID
invoices.line_items.tax_id string

税务标识符。

TDS 税务 ID
invoices.line_items.tds_tax_id string

TDS 税务标识符。

Name
invoices.line_items.tax_name string

税务名称。

税务类型
invoices.line_items.tax_type string

税类型。

税务百分比
invoices.line_items.tax_percentage double

税收百分比。

项目总计
invoices.line_items.item_total double

项总数。

SAT 项密钥代码
invoices.line_items.sat_item_key_code integer

SAT 项密钥代码。

单元密钥代码
invoices.line_items.unitkey_code string

单元键代码。

寄送费用
invoices.shipping_charge double

发货费用。

调整
invoices.adjustment double

调整。

调整说明
invoices.adjustment_description string

调整说明。

小计
invoices.sub_total double

分类汇总。

税款总额
invoices.tax_total double

税款总额。

Total
invoices.total double

总计。

税款
invoices.taxes array of object
Name
invoices.taxes.tax_name string

税务名称。

金额
invoices.taxes.tax_amount double

税额。

已启用付款提醒
invoices.payment_reminder_enabled boolean

是否启用付款提醒。

付款
invoices.payment_made double

付款。

已应用的额度
invoices.credits_applied double

应用的信用额度。

扣缴税款
invoices.tax_amount_withheld double

扣缴的税额。

所有者权益
invoices.balance double

余额。

注销金额
invoices.write_off_amount double

注销金额。

允许部分付款
invoices.allow_partial_payments boolean

是否允许部分付款。

价格精度
invoices.price_precision integer

价格精度。

Gateway
invoices.payment_options.payment_gateways array of object
配置
invoices.payment_options.payment_gateways.configured boolean

是否已配置。

其他字段
invoices.payment_options.payment_gateways.additional_field1 string

其他字段。

Name
invoices.payment_options.payment_gateways.gateway_name string

网关名称。

已通过电子邮件发送
invoices.is_emailed boolean

是否已发送电子邮件。

已发送提醒
invoices.reminders_sent integer

发送的提醒数。

上次提醒发送日期
invoices.last_reminder_sent_date string

上次发送的提醒日期。

地址
invoices.billing_address.address string

地址。

City
invoices.billing_address.city string

城市。

State
invoices.billing_address.state string

省/市/自治区。

邮政编码
invoices.billing_address.zip string

邮政编码。

国家
invoices.billing_address.country string

国家/ 地区。

传真
invoices.billing_address.fax string

传真号。

地址
invoices.shipping_address.address string

地址。

City
invoices.shipping_address.city string

城市。

State
invoices.shipping_address.state string

省/市/自治区。

邮政编码
invoices.shipping_address.zip string

邮政编码。

国家
invoices.shipping_address.country string

国家/ 地区。

传真
invoices.shipping_address.fax string

传真号。

注释
invoices.notes string

备注。

术语
invoices.terms string

术语。

自定义域
invoices.custom_fields array of object
ID
invoices.custom_fields.customfield_id string

自定义字段标识符。

数据类型
invoices.custom_fields.data_type string

数据类型。

Index
invoices.custom_fields.index integer

索引号。

标签
invoices.custom_fields.label string

标签。

在 PDF 上显示
invoices.custom_fields.show_on_pdf boolean

是否在 PDF 上显示。

在所有 PDF 中显示
invoices.custom_fields.show_in_all_pdf boolean

是否在所有 PDF 中显示。

价值
invoices.custom_fields.value double

自定义字段值。

模板编号
invoices.template_id string

模板标识符。

模板名称
invoices.template_name string

模板名称。

创建时间
invoices.created_time string

创建的时间。

上次修改时间
invoices.last_modified_time string

上次修改时间。

附件名称
invoices.attachment_name string

附件名称。

可以在邮件中发送邮件
invoices.can_send_in_mail boolean

是否可以发送邮件。

销售人员 ID
invoices.salesperson_id string

销售人员标识符。

Salesperson 名称
invoices.salesperson_name string

销售人员的姓名。

URL
invoices.invoice_url string

发票 URL 地址。

获取联系人

检索现有联系人的详细信息。

参数

名称 密钥 必需 类型 说明
触点 ID
contact_id True string

联系人标识符。

返回

名称 路径 类型 说明
状态代码
code integer

状态代码。

状态消息
message string

状态消息。

触点 ID
contact.contact_id string

联系人标识符。

联系人姓名
contact.contact_name string

联系人姓名。

公司名称
contact.company_name string

公司名称。

具有事务
contact.has_transaction boolean

是否具有事务。

联系人类型
contact.contact_type string

联系人类型。

应纳税
contact.is_taxable boolean

是否应纳税。

税务 ID
contact.tax_id string

税务标识符。

税务名称
contact.tax_name string

税务名称。

税务百分比
contact.tax_percentage integer

税收百分比。

税务机构 ID
contact.tax_authority_id string

税务机构标识符。

免税 ID
contact.tax_exemption_id string

免税标识符。

税务机构名称
contact.tax_authority_name string

税务机构名称。

免税代码
contact.tax_exemption_code string

免税代码。

联系人位置
contact.place_of_contact string

联系人的位置。

GST 编号
contact.gst_no string

GST 编号。

VAT 处理
contact.vat_treatment string

增值税待遇。

GST 治疗
contact.gst_treatment string

GST 治疗。

与 Zoho CRM 链接
contact.is_linked_with_zohocrm boolean

是否与 Zoho CRM 链接。

网站
contact.website string

网站。

主要联系人 ID
contact.primary_contact_id string

主要联系人标识符。

付款条款
contact.payment_terms integer

付款条款。

付款条款标签
contact.payment_terms_label string

付款条款标签。

货币 ID
contact.currency_id string

货币标识符。

货币代码
contact.currency_code string

货币代码。

货币符号
contact.currency_symbol string

货币符号。

未偿还应收金额
contact.outstanding_receivable_amount double

未偿还应收金额。

未偿还应收金额 BCY
contact.outstanding_receivable_amount_bcy double

BCY 未偿还应收金额。

未使用的信用额度应收金额
contact.unused_credits_receivable_amount double

未使用的信用额度应收金额。

未使用的信用额度应收金额 BCY
contact.unused_credits_receivable_amount_bcy double

BCY 未使用的应收信贷金额。

状态
contact.status string

状态。

脸书
contact.facebook string

Facebook 帐户。

推特
contact.twitter string

Twitter 句柄。

已启用付款提醒
contact.payment_reminder_enabled boolean

是否启用付款提醒。

自定义域
contact.custom_fields array of object
价值
contact.custom_fields.value string

自定义字段值。

Index
contact.custom_fields.index integer

索引号。

标签
contact.custom_fields.label string

标签。

注意
contact.billing_address.attention string

注意名称。

地址
contact.billing_address.address string

地址。

街道
contact.billing_address.street2 string

街道地址。

省/直辖市/自治区代码
contact.billing_address.state_code string

状态代码。

City
contact.billing_address.city string

城市。

State
contact.billing_address.state string

省/市/自治区。

邮政编码
contact.billing_address.zip string

邮政编码。

国家
contact.billing_address.country string

国家/ 地区。

传真
contact.billing_address.fax string

传真号。

电话
contact.billing_address.phone string

电话号码。

注意
contact.shipping_address.attention string

注意名称。

地址
contact.shipping_address.address string

地址。

街道
contact.shipping_address.street2 string

街道地址。

省/直辖市/自治区代码
contact.shipping_address.state_code string

状态代码。

City
contact.shipping_address.city string

城市。

State
contact.shipping_address.state string

省/市/自治区。

邮政编码
contact.shipping_address.zip string

邮政编码。

国家
contact.shipping_address.country string

国家/ 地区。

传真
contact.shipping_address.fax string

传真号。

电话
contact.shipping_address.phone string

电话号码。

联系人
contact.contact_persons array of object
称呼
contact.contact_persons.salutation string

敬礼。

名字
contact.contact_persons.first_name string

名。

姓氏
contact.contact_persons.last_name string

姓。

Email
contact.contact_persons.email string

电子邮件地址。

电话
contact.contact_persons.phone string

电话号码。

手机
contact.contact_persons.mobile string

移动电话号码。

是主要联系人
contact.contact_persons.is_primary_contact boolean

是否是主要联系人。

发票模板 ID
contact.default_templates.invoice_template_id string

发票模板标识符。

发票模板名称
contact.default_templates.invoice_template_name string

发票模板名称。

估计模板 ID
contact.default_templates.estimate_template_id string

估计模板标识符。

估计模板名称
contact.default_templates.estimate_template_name string

估计模板名称。

信用说明模板 ID
contact.default_templates.creditnote_template_id string

信用说明模板标识符。

信用说明模板名称
contact.default_templates.creditnote_template_name string

信用说明模板名称。

发票电子邮件模板 ID
contact.default_templates.invoice_email_template_id string

发票电子邮件模板标识符。

发票电子邮件模板名称
contact.default_templates.invoice_email_template_name string

发票电子邮件模板名称。

估计电子邮件模板 ID
contact.default_templates.estimate_email_template_id string

估计电子邮件模板标识符。

估计电子邮件模板名称
contact.default_templates.estimate_email_template_name string

估计电子邮件模板名称。

信用说明电子邮件模板 ID
contact.default_templates.creditnote_email_template_id string

信用说明电子邮件模板标识符。

信用说明电子邮件模板名称
contact.default_templates.creditnote_email_template_name string

信用说明电子邮件模板名称。

注释
contact.notes string

备注。

创建时间
contact.created_time string

创建的时间。

上次修改时间
contact.last_modified_time string

上次修改时间。

获取联系人

检索具有分页的所有联系人的列表。

参数

名称 密钥 必需 类型 说明
联系人姓名
contact_name string

联系人姓名。

公司 ID
company_name string

公司标识符。

名字
first_name string

名。

Last Nam
last_name string

姓。

地址
address string

地址。

Email
email string

电子邮件地址。

电话
phone string

电话地址。

筛选依据
filter_by string

筛选器依据。

搜索文本
search_text string

搜索文本。

对列进行排序
sort_column string

排序列。

Zoho CRM 联系人 ID
zcrm_contact_id integer

Zoho CRM 联系人标识符。

Zoho CRM 帐户 ID
zcrm_account_id integer

Zoho CRM 帐户标识符。

page integer

页码。

每页
per_page integer

每页码。

返回

名称 路径 类型 说明
状态代码
code integer

状态代码。

状态消息
message string

状态消息。

联系
contact array of object
触点 ID
contact.contact_id string

联系人标识符。

联系人姓名
contact.contact_name string

联系人姓名。

公司名称
contact.company_name string

公司名称。

联系人类型
contact.contact_type string

联系人类型。

付款条款
contact.payment_terms integer

付款条款。

付款条款标签
contact.payment_terms_label string

付款条款标签。

货币 ID
contact.currency_id string

货币标识符。

货币代码
contact.currency_code string

货币代码。

未偿还应收金额
contact.outstanding_receivable_amount double

未偿还应收金额。

未使用的信用额度应收金额
contact.unused_credits_receivable_amount double

未使用的信用额度应收金额。

状态
contact.status string

状态。

创建时间
contact.created_time string

创建的时间。

上次修改时间
contact.last_modified_time string

上次修改时间。