Zoho Invoice Basic (独立した発行元) (プレビュー)
専門的な請求書をカスタマイズして作成し、ハードワークの支払いを受けます。 Zoho Invoice は、使いやすく、完全に無料で、永遠に利用できる小規模企業向けのオンライン請求書管理ソフトウェアです。
このコネクタは、次の製品とリージョンで使用できます。
| サービス | クラス | リージョン |
|---|---|---|
| コピロット スタジオ | Premium | 次を除くすべての Power Automate リージョン : - 米国政府 (GCC) - 米国政府 (GCC High) - 21Vianet が運営する China Cloud - 米国国防総省 (DoD) |
| ロジック アプリ | Standard | 次を除くすべての Logic Apps リージョン : - Azure Government リージョン - Azure China リージョン - 米国国防総省 (DoD) |
| Power Apps | Premium | 次を除くすべての Power Apps リージョン : - 米国政府 (GCC) - 米国政府 (GCC High) - 21Vianet が運営する China Cloud - 米国国防総省 (DoD) |
| Power Automate | Premium | 次を除くすべての Power Automate リージョン : - 米国政府 (GCC) - 米国政府 (GCC High) - 21Vianet が運営する China Cloud - 米国国防総省 (DoD) |
| お問い合わせ | |
|---|---|
| 名前 | トロイ・テイラー |
| URL | https://www.troystaylor.com |
| troy@troystaylor.com |
| コネクタ メタデータ | |
|---|---|
| Publisher | トロイ・テイラー |
| Website | https://www.zoho.com/us/invoice/ |
| プライバシー ポリシー | https://www.zoho.com/privacy.html |
| カテゴリ | 金融;売上と CRM |
接続を作成する
コネクタでは、次の認証の種類がサポートされています。
| デフォルト | 接続を作成するためのパラメーター。 | すべてのリージョン | 共有不可 |
デフォルト
適用対象: すべてのリージョン
接続を作成するためのパラメーター。
これは共有可能な接続ではありません。 電源アプリが別のユーザーと共有されている場合、別のユーザーは新しい接続を明示的に作成するように求められます。
| 名前 | タイプ | Description | 必須 |
|---|---|---|---|
| Zoho 組織 ID | 文字列 | この API の Zoho 組織識別子 | 正しい |
| クライアントID | 文字列 | この API のクライアント ID | 正しい |
| クライアント シークレット | securestring | この API のクライアント シークレット | 正しい |
調整制限
| 名前 | 呼び出し | 更新期間 |
|---|---|---|
| 接続ごとの API 呼び出し | 100 | 60 秒 |
アクション
| 請求書を作成する |
顧客の請求書を作成します。 |
| 請求書を削除する |
既存の請求書を削除します。 支払いまたはクレジットのメモが適用されている請求書は削除できません。 |
| 請求書を取得する |
請求書の詳細を取得する |
| 請求書を取得する |
改ページ位置付きの請求書の一覧を取得します。 |
| 請求書を更新する |
既存の請求書を更新します。 行項目を削除するには、line_itemsリストから削除します。 |
| 連絡先を作成する |
新しい連絡先を作成します。 |
| 連絡先を削除する |
既存の連絡先を削除します。 |
| 連絡先を取得する |
既存の連絡先の詳細を取得します。 |
| 連絡先を取得する |
改ページ位置が設定されているすべての連絡先の一覧を取得します。 |
| 連絡先を更新する |
既存の連絡先を更新します。 |
請求書を作成する
顧客の請求書を作成します。
パラメーター
| 名前 | キー | 必須 | 型 | 説明 |
|---|---|---|---|---|
|
Send
|
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 の処理
|
vat_treatment | string |
VAT 処理。 |
|
|
GST 治療
|
gst_treatment | string |
GST治療。 |
|
|
税金の扱い
|
tax_treatment | string |
税金の扱い。 |
|
|
CFDI の使用法
|
cfdi_usage | string |
CFDI の使用法。 |
|
|
GST 番号
|
gst_no | string |
GST 番号。 |
|
|
テンプレート識別子
|
template_id | string |
テンプレート識別子。 |
|
|
日付
|
date | string |
日付。 |
|
|
支払条件
|
payment_terms | integer |
支払条件。 |
|
|
支払条件ラベル
|
payment_terms_label | string |
支払条件ラベル。 |
|
|
期日
|
due_date | string |
期限。 |
|
|
Discount
|
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_name | string |
販売員名。 |
|
|
ラベル
|
label | string |
ラベル。 |
|
|
価値
|
value | float |
値。 |
|
|
プロジェクト ID
|
project_id | string |
プロジェクト識別子。 |
|
|
ID
|
item_id | string |
アイテム識別子。 |
|
|
プロジェクト ID
|
project_id | string |
プロジェクト識別子。 |
|
|
タイム エントリ ID
|
time_entry_ids | array of integer |
時刻エントリ識別子。 |
|
|
経費 ID
|
expense_id | string |
経費識別子。 |
|
|
名前
|
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
|
discount | float |
割引。 |
|
|
納税者番号
|
tax_id | string |
税識別子。 |
|
|
TDS 税 ID
|
tds_tax_id | string |
TDS 税識別子。 |
|
|
免税 ID
|
tax_exemption_id | string |
非課税識別子。 |
|
|
AvaTax のコードの使用
|
avatax_use_code | string |
AvaTax はコードを使用します。 |
|
|
AvaTax Exempt No
|
avatax_exempt_no | string |
AvaTax の除外番号。 |
|
|
税名
|
tax_name | string |
税名。 |
|
|
税の種類
|
tax_type | string |
税の種類。 |
|
|
税の割合
|
tax_percentage | float |
税の割合。 |
|
|
合計
|
item_total | float |
アイテムの合計。 |
|
|
構成
|
configured | boolean |
構成されているかどうか。 |
|
|
追加フィールド
|
additional_field1 | string |
追加のフィールド。 |
|
|
名前
|
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 支払いが開始されたかどうか。 |
|
Number
|
invoice.invoice_number | string |
請求書番号。 |
|
Is Pre-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 |
税金の扱い。 |
|
CFDI の使用法
|
invoice.cfdi_usage | string |
CFDI の使用法。 |
|
VAT の処理
|
invoice.vat_treatment | string |
VAT 処理。 |
|
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 |
為替レート。 |
|
Discount
|
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 |
アイテム識別子。 |
|
プロジェクト ID
|
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 |
経費受領書の名前。 |
|
名前
|
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 |
割引額。 |
|
Discount
|
invoice.line_items.discount | double |
割引。 |
|
ID
|
invoice.line_items.tax_id | string |
税識別子。 |
|
TDS 税 ID
|
invoice.line_items.tds_tax_id | string |
TDS 税識別子。 |
|
名前
|
invoice.line_items.tax_name | string |
税名。 |
|
税の種類
|
invoice.line_items.tax_type | string |
税の種類。 |
|
税の割合
|
invoice.line_items.tax_percentage | double |
税の割合。 |
|
Item Total
|
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 |
調整の説明。 |
|
Subtotal
|
invoice.sub_total | double |
小計。 |
|
税合計
|
invoice.tax_total | double |
合計税。 |
|
合計
|
invoice.total | double |
合計。 |
|
税金
|
invoice.taxes | array of object | |
|
名前
|
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 |
追加のフィールド。 |
|
名前
|
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 |
アドレス。 |
|
市区町村
|
invoice.billing_address.city | string |
市区町村。 |
|
State
|
invoice.billing_address.state | string |
都道府県。 |
|
ZIPファイル
|
invoice.billing_address.zip | string |
郵便番号。 |
|
Country
|
invoice.billing_address.country | string |
国。 |
|
ファクス
|
invoice.billing_address.fax | string |
FAX 番号。 |
|
住所
|
invoice.shipping_address.address | string |
アドレス。 |
|
市区町村
|
invoice.shipping_address.city | string |
市区町村。 |
|
State
|
invoice.shipping_address.state | string |
都道府県。 |
|
ZIPファイル
|
invoice.shipping_address.zip | string |
郵便番号。 |
|
Country
|
invoice.shipping_address.country | string |
国。 |
|
ファクス
|
invoice.shipping_address.fax | string |
FAX 番号。 |
|
注記
|
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 |
販売員識別子。 |
|
販売員名
|
invoice.salesperson_name | string |
営業担当者の名前。 |
|
URL
|
invoice.invoice_url | string |
請求書の URL アドレス。 |
請求書を削除する
既存の請求書を削除します。 支払いまたはクレジットのメモが適用されている請求書は削除できません。
パラメーター
| 名前 | キー | 必須 | 型 | 説明 |
|---|---|---|---|---|
|
請求書識別子
|
invoice_id | True | string |
請求書識別子。 |
戻り値
| 名前 | パス | 型 | 説明 |
|---|---|---|---|
|
状態コード
|
code | integer |
状態コード。 |
|
ステータス メッセージ
|
message | string |
状態メッセージ。 |
請求書を取得する
請求書の詳細を取得する
パラメーター
| 名前 | キー | 必須 | 型 | 説明 |
|---|---|---|---|---|
|
請求書識別子
|
invoice_id | True | string |
請求書識別子。 |
戻り値
| 名前 | パス | 型 | 説明 |
|---|---|---|---|
|
状態コード
|
code | integer |
状態コード。 |
|
ステータス メッセージ
|
message | string |
状態メッセージ。 |
|
ID
|
invoice.invoice_id | string |
請求書識別子。 |
|
ACH 支払い開始
|
invoice.ach_payment_initiated | boolean |
ACH 支払いが開始されたかどうか。 |
|
Number
|
invoice.invoice_number | string |
請求書番号。 |
|
Is Pre-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 |
税金の扱い。 |
|
CFDI の使用法
|
invoice.cfdi_usage | string |
CFDI の使用法。 |
|
VAT の処理
|
invoice.vat_treatment | string |
VAT 処理。 |
|
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 |
為替レート。 |
|
Discount
|
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 |
アイテム識別子。 |
|
プロジェクト ID
|
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 |
経費受領書の名前。 |
|
名前
|
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 |
割引額。 |
|
Discount
|
invoice.line_items.discount | double |
割引。 |
|
ID
|
invoice.line_items.tax_id | string |
税識別子。 |
|
TDS 税 ID
|
invoice.line_items.tds_tax_id | string |
TDS 税識別子。 |
|
名前
|
invoice.line_items.tax_name | string |
税名。 |
|
税の種類
|
invoice.line_items.tax_type | string |
税の種類。 |
|
税の割合
|
invoice.line_items.tax_percentage | double |
税の割合。 |
|
Item Total
|
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 |
調整の説明。 |
|
Subtotal
|
invoice.sub_total | double |
小計。 |
|
税合計
|
invoice.tax_total | double |
合計税。 |
|
合計
|
invoice.total | double |
合計。 |
|
税金
|
invoice.taxes | array of object | |
|
名前
|
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 |
追加のフィールド。 |
|
名前
|
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 |
アドレス。 |
|
市区町村
|
invoice.billing_address.city | string |
市区町村。 |
|
State
|
invoice.billing_address.state | string |
都道府県。 |
|
ZIPファイル
|
invoice.billing_address.zip | string |
郵便番号。 |
|
Country
|
invoice.billing_address.country | string |
国。 |
|
ファクス
|
invoice.billing_address.fax | string |
FAX 番号。 |
|
住所
|
invoice.shipping_address.address | string |
アドレス。 |
|
市区町村
|
invoice.shipping_address.city | string |
市区町村。 |
|
State
|
invoice.shipping_address.state | string |
都道府県。 |
|
ZIPファイル
|
invoice.shipping_address.zip | string |
郵便番号。 |
|
Country
|
invoice.shipping_address.country | string |
国。 |
|
ファクス
|
invoice.shipping_address.fax | string |
FAX 番号。 |
|
注記
|
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 |
販売員識別子。 |
|
販売員名
|
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
|
string |
電子メール アドレス。 |
||
|
合計
|
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 Potential ID
|
zcrm_potential_id | string |
Zoho CRM の潜在的な識別子。 |
|
|
ページ
|
page | integer |
ページ番号。 |
|
|
ページごと
|
per_page | integer |
ページごとの番号。 |
戻り値
| 名前 | パス | 型 | 説明 |
|---|---|---|---|
|
状態コード
|
code | integer |
状態コード。 |
|
ステータス メッセージ
|
message | string |
状態メッセージ。 |
|
invoices
|
invoices | array of object | |
|
ID
|
invoices.invoice_id | string |
請求書識別子。 |
|
ACH 支払い開始
|
invoices.ach_payment_initiated | boolean |
ACH 支払いが開始されたかどうか。 |
|
Number
|
invoices.invoice_number | string |
請求書番号。 |
|
Is Pre-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 |
税金の扱い。 |
|
CFDI の使用法
|
invoices.cfdi_usage | string |
CFDI の使用法。 |
|
VAT の処理
|
invoices.vat_treatment | string |
VAT 処理。 |
|
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 |
為替レート。 |
|
Discount
|
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 |
アイテム識別子。 |
|
プロジェクト ID
|
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 |
経費受領書の名前。 |
|
名前
|
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 |
割引額。 |
|
Discount
|
invoices.line_items.discount | double |
割引。 |
|
ID
|
invoices.line_items.tax_id | string |
税識別子。 |
|
TDS 税 ID
|
invoices.line_items.tds_tax_id | string |
TDS 税識別子。 |
|
名前
|
invoices.line_items.tax_name | string |
税名。 |
|
税の種類
|
invoices.line_items.tax_type | string |
税の種類。 |
|
税の割合
|
invoices.line_items.tax_percentage | double |
税の割合。 |
|
Item Total
|
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 |
調整の説明。 |
|
Subtotal
|
invoices.sub_total | double |
小計。 |
|
税合計
|
invoices.tax_total | double |
合計税。 |
|
合計
|
invoices.total | double |
合計。 |
|
税金
|
invoices.taxes | array of object | |
|
名前
|
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 |
追加のフィールド。 |
|
名前
|
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 |
アドレス。 |
|
市区町村
|
invoices.billing_address.city | string |
市区町村。 |
|
State
|
invoices.billing_address.state | string |
都道府県。 |
|
ZIPファイル
|
invoices.billing_address.zip | string |
郵便番号。 |
|
Country
|
invoices.billing_address.country | string |
国。 |
|
ファクス
|
invoices.billing_address.fax | string |
FAX 番号。 |
|
住所
|
invoices.shipping_address.address | string |
アドレス。 |
|
市区町村
|
invoices.shipping_address.city | string |
市区町村。 |
|
State
|
invoices.shipping_address.state | string |
都道府県。 |
|
ZIPファイル
|
invoices.shipping_address.zip | string |
郵便番号。 |
|
Country
|
invoices.shipping_address.country | string |
国。 |
|
ファクス
|
invoices.shipping_address.fax | string |
FAX 番号。 |
|
注記
|
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 |
販売員識別子。 |
|
販売員名
|
invoices.salesperson_name | string |
営業担当者の名前。 |
|
URL
|
invoices.invoice_url | string |
請求書の URL アドレス。 |
請求書を更新する
既存の請求書を更新します。 行項目を削除するには、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 の処理
|
vat_treatment | string |
VAT 処理。 |
|
|
GST 治療
|
gst_treatment | string |
GST治療。 |
|
|
税金の扱い
|
tax_treatment | string |
税金の扱い。 |
|
|
CFDI の使用法
|
cfdi_usage | string |
CFDI の使用法。 |
|
|
GST 番号
|
gst_no | string |
GST 番号。 |
|
|
テンプレート識別子
|
template_id | string |
テンプレート識別子。 |
|
|
日付
|
date | string |
日付。 |
|
|
支払条件
|
payment_terms | integer |
支払条件。 |
|
|
支払条件ラベル
|
payment_terms_label | string |
支払条件ラベル。 |
|
|
期日
|
due_date | string |
期限。 |
|
|
Discount
|
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_name | string |
販売員名。 |
|
|
ラベル
|
label | string |
ラベル。 |
|
|
価値
|
value | float |
値。 |
|
|
プロジェクト ID
|
project_id | string |
プロジェクト識別子。 |
|
|
ID
|
item_id | string |
アイテム識別子。 |
|
|
プロジェクト ID
|
project_id | string |
プロジェクト識別子。 |
|
|
タイム エントリ ID
|
time_entry_ids | array of integer |
時刻エントリ識別子。 |
|
|
経費 ID
|
expense_id | string |
経費識別子。 |
|
|
名前
|
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
|
discount | float |
割引。 |
|
|
納税者番号
|
tax_id | string |
税識別子。 |
|
|
TDS 税 ID
|
tds_tax_id | string |
TDS 税識別子。 |
|
|
免税 ID
|
tax_exemption_id | string |
非課税識別子。 |
|
|
AvaTax のコードの使用
|
avatax_use_code | string |
AvaTax はコードを使用します。 |
|
|
AvaTax Exempt No
|
avatax_exempt_no | string |
AvaTax の除外番号。 |
|
|
税名
|
tax_name | string |
税名。 |
|
|
税の種類
|
tax_type | string |
税の種類。 |
|
|
税の割合
|
tax_percentage | float |
税の割合。 |
|
|
合計
|
item_total | float |
アイテムの合計。 |
|
|
構成
|
configured | boolean |
構成されているかどうか。 |
|
|
追加フィールド
|
additional_field1 | string |
追加のフィールド。 |
|
|
名前
|
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 支払いが開始されたかどうか。 |
|
Number
|
invoice.invoice_number | string |
請求書番号。 |
|
Is Pre-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 |
税金の扱い。 |
|
CFDI の使用法
|
invoice.cfdi_usage | string |
CFDI の使用法。 |
|
VAT の処理
|
invoice.vat_treatment | string |
VAT 処理。 |
|
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 |
為替レート。 |
|
Discount
|
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 |
アイテム識別子。 |
|
プロジェクト ID
|
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 |
経費受領書の名前。 |
|
名前
|
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 |
割引額。 |
|
Discount
|
invoice.line_items.discount | double |
割引。 |
|
ID
|
invoice.line_items.tax_id | string |
税識別子。 |
|
TDS 税 ID
|
invoice.line_items.tds_tax_id | string |
TDS 税識別子。 |
|
名前
|
invoice.line_items.tax_name | string |
税名。 |
|
税の種類
|
invoice.line_items.tax_type | string |
税の種類。 |
|
税の割合
|
invoice.line_items.tax_percentage | double |
税の割合。 |
|
Item Total
|
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 |
調整の説明。 |
|
Subtotal
|
invoice.sub_total | double |
小計。 |
|
税合計
|
invoice.tax_total | double |
合計税。 |
|
合計
|
invoice.total | double |
合計。 |
|
税金
|
invoice.taxes | array of object | |
|
名前
|
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 |
追加のフィールド。 |
|
名前
|
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 |
アドレス。 |
|
市区町村
|
invoice.billing_address.city | string |
市区町村。 |
|
State
|
invoice.billing_address.state | string |
都道府県。 |
|
ZIPファイル
|
invoice.billing_address.zip | string |
郵便番号。 |
|
Country
|
invoice.billing_address.country | string |
国。 |
|
ファクス
|
invoice.billing_address.fax | string |
FAX 番号。 |
|
住所
|
invoice.shipping_address.address | string |
アドレス。 |
|
市区町村
|
invoice.shipping_address.city | string |
市区町村。 |
|
State
|
invoice.shipping_address.state | string |
都道府県。 |
|
ZIPファイル
|
invoice.shipping_address.zip | string |
郵便番号。 |
|
Country
|
invoice.shipping_address.country | string |
国。 |
|
ファクス
|
invoice.shipping_address.fax | string |
FAX 番号。 |
|
注記
|
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 |
販売員識別子。 |
|
販売員名
|
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
|
website | string |
Web サイト。 |
|
|
価値
|
value | string |
ユーザー設定フィールドの値。 |
|
|
Index
|
index | integer |
インデックス番号。 |
|
|
注目
|
attention | string |
アテンション名。 |
|
|
住所
|
address | string |
アドレス。 |
|
|
住所 2
|
street2 | string |
アドレス 2。 |
|
|
State
|
state_code | string |
状態の省略形。 |
|
|
市区町村
|
city | string |
市区町村。 |
|
|
State
|
state | string |
都道府県。 |
|
|
ZIPファイル
|
zip | string |
郵便番号。 |
|
|
Country
|
country | string |
国。 |
|
|
ファクス
|
fax | string |
FAX 番号。 |
|
|
電話
|
phone | string |
電話番号。 |
|
|
注目
|
attention | string |
アテンション名。 |
|
|
住所
|
address | string |
アドレス。 |
|
|
住所 2
|
street2 | string |
アドレス 2。 |
|
|
State
|
state_code | string |
状態の省略形。 |
|
|
市区町村
|
city | string |
市区町村。 |
|
|
State
|
state | string |
都道府県。 |
|
|
ZIPファイル
|
zip | string |
郵便番号。 |
|
|
Country
|
country | string |
国。 |
|
|
ファクス
|
fax | string |
FAX 番号。 |
|
|
電話
|
phone | string |
電話番号。 |
|
|
Salutation
|
salutation | string |
挨拶。 |
|
|
名前
|
first_name | string |
名。 |
|
|
姓
|
last_name | string |
姓。 |
|
|
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 |
税務当局の識別子。 |
|
|
納税者番号
|
tax_id | string |
税識別子。 |
|
|
TDS 税 ID
|
tds_tax_id | string |
TDS 税識別子。 |
|
|
課税対象
|
is_taxable | boolean |
課税対象かどうか。 |
|
|
フェイスブック
|
string |
Facebook ユーザー名。 |
||
|
ツイッター
|
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 |
課税対象かどうか。 |
|
納税者番号
|
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 |
VAT 処理。 |
|
税金の扱い
|
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 にリンクされているかどうか。 |
|
Website
|
contact.website | string |
Web サイト。 |
|
プライマリ連絡先 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 |
アドレス。 |
|
Street
|
contact.billing_address.street2 | string |
番地。 |
|
状態コード
|
contact.billing_address.state_code | string |
状態コード。 |
|
市区町村
|
contact.billing_address.city | string |
市区町村。 |
|
State
|
contact.billing_address.state | string |
都道府県。 |
|
ZIPファイル
|
contact.billing_address.zip | string |
郵便番号。 |
|
Country
|
contact.billing_address.country | string |
国。 |
|
ファクス
|
contact.billing_address.fax | string |
FAX 番号。 |
|
電話
|
contact.billing_address.phone | string |
電話番号。 |
|
注目
|
contact.shipping_address.attention | string |
アテンション名。 |
|
住所
|
contact.shipping_address.address | string |
アドレス。 |
|
Street
|
contact.shipping_address.street2 | string |
番地。 |
|
状態コード
|
contact.shipping_address.state_code | string |
状態コード。 |
|
市区町村
|
contact.shipping_address.city | string |
市区町村。 |
|
State
|
contact.shipping_address.state | string |
都道府県。 |
|
ZIPファイル
|
contact.shipping_address.zip | string |
郵便番号。 |
|
Country
|
contact.shipping_address.country | string |
国。 |
|
ファクス
|
contact.shipping_address.fax | string |
FAX 番号。 |
|
電話
|
contact.shipping_address.phone | string |
電話番号。 |
|
フェイスブック
|
contact.facebook | string |
Facebook アカウント。 |
|
ツイッター
|
contact.twitter | string |
Twitter ハンドル。 |
|
連絡先
|
contact.contact_persons | array of object | |
|
Salutation
|
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 |
最後に変更された時刻。 |
連絡先を削除する
既存の連絡先を削除します。
パラメーター
| 名前 | キー | 必須 | 型 | 説明 |
|---|---|---|---|---|
|
接触 ID
|
contact_id | True | string |
連絡先識別子。 |
戻り値
| 名前 | パス | 型 | 説明 |
|---|---|---|---|
|
状態コード
|
code | integer |
状態コード。 |
|
ステータス メッセージ
|
message | string |
状態メッセージ。 |
連絡先を取得する
既存の連絡先の詳細を取得します。
パラメーター
| 名前 | キー | 必須 | 型 | 説明 |
|---|---|---|---|---|
|
接触 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 |
課税対象かどうか。 |
|
納税者番号
|
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 |
VAT 処理。 |
|
GST 治療
|
contact.gst_treatment | string |
GST治療。 |
|
Zoho CRM とリンクされている
|
contact.is_linked_with_zohocrm | boolean |
Zoho CRM にリンクされているかどうか。 |
|
Website
|
contact.website | string |
Web サイト。 |
|
プライマリ連絡先 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 |
アドレス。 |
|
Street
|
contact.billing_address.street2 | string |
番地。 |
|
状態コード
|
contact.billing_address.state_code | string |
状態コード。 |
|
市区町村
|
contact.billing_address.city | string |
市区町村。 |
|
State
|
contact.billing_address.state | string |
都道府県。 |
|
ZIPファイル
|
contact.billing_address.zip | string |
郵便番号。 |
|
Country
|
contact.billing_address.country | string |
国。 |
|
ファクス
|
contact.billing_address.fax | string |
FAX 番号。 |
|
電話
|
contact.billing_address.phone | string |
電話番号。 |
|
注目
|
contact.shipping_address.attention | string |
アテンション名。 |
|
住所
|
contact.shipping_address.address | string |
アドレス。 |
|
Street
|
contact.shipping_address.street2 | string |
番地。 |
|
状態コード
|
contact.shipping_address.state_code | string |
状態コード。 |
|
市区町村
|
contact.shipping_address.city | string |
市区町村。 |
|
State
|
contact.shipping_address.state | string |
都道府県。 |
|
ZIPファイル
|
contact.shipping_address.zip | string |
郵便番号。 |
|
Country
|
contact.shipping_address.country | string |
国。 |
|
ファクス
|
contact.shipping_address.fax | string |
FAX 番号。 |
|
電話
|
contact.shipping_address.phone | string |
電話番号。 |
|
連絡先
|
contact.contact_persons | array of object | |
|
Salutation
|
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
|
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 |
最後に変更された時刻。 |
連絡先を更新する
既存の連絡先を更新します。
パラメーター
| 名前 | キー | 必須 | 型 | 説明 |
|---|---|---|---|---|
|
接触 ID
|
contact_id | True | string |
連絡先識別子。 |
|
連絡先の名前
|
contact_name | True | string |
連絡先の名前。 |
|
会社名
|
company_name | string |
会社名。 |
|
|
支払条件
|
payment_terms | integer |
支払条件。 |
|
|
通貨 ID
|
currency_id | string |
通貨識別子。 |
|
|
Website
|
website | string |
Web サイト。 |
|
|
価値
|
value | string |
ユーザー設定フィールドの値。 |
|
|
Index
|
index | integer |
インデックス番号。 |
|
|
ラベル
|
label | string |
ラベル。 |
|
|
注目
|
attention | string |
アテンション名。 |
|
|
住所
|
address | string |
アドレス。 |
|
|
住所 2
|
street2 | string |
アドレス 2。 |
|
|
State
|
state_code | string |
状態の省略形。 |
|
|
市区町村
|
city | string |
市区町村。 |
|
|
State
|
state | string |
都道府県。 |
|
|
ZIPファイル
|
zip | string |
郵便番号。 |
|
|
Country
|
country | string |
国。 |
|
|
ファクス
|
fax | string |
FAX 番号。 |
|
|
電話
|
phone | string |
電話番号。 |
|
|
注目
|
attention | string |
アテンション名。 |
|
|
住所
|
address | string |
アドレス。 |
|
|
住所 2
|
street2 | string |
アドレス 2。 |
|
|
State
|
state_code | string |
状態の省略形。 |
|
|
市区町村
|
city | string |
市区町村。 |
|
|
State
|
state | string |
都道府県。 |
|
|
ZIPファイル
|
zip | string |
郵便番号。 |
|
|
Country
|
country | string |
国。 |
|
|
ファクス
|
fax | string |
FAX 番号。 |
|
|
電話
|
phone | string |
電話番号。 |
|
|
Salutation
|
salutation | string |
挨拶。 |
|
|
名前
|
first_name | string |
名。 |
|
|
姓
|
last_name | string |
姓。 |
|
|
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 |
税務当局の識別子。 |
|
|
納税者番号
|
tax_id | string |
税識別子。 |
|
|
TDS 税 ID
|
tds_tax_id | string |
TDS 税識別子。 |
|
|
課税対象
|
is_taxable | boolean |
課税対象かどうか。 |
|
|
フェイスブック
|
string |
Facebook ユーザー名。 |
||
|
ツイッター
|
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 |
課税対象かどうか。 |
|
納税者番号
|
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 |
VAT 処理。 |
|
税金の扱い
|
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 にリンクされているかどうか。 |
|
Website
|
contact.website | string |
Web サイト。 |
|
プライマリ連絡先 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 |
アドレス。 |
|
Street
|
contact.billing_address.street2 | string |
番地。 |
|
状態コード
|
contact.billing_address.state_code | string |
状態コード。 |
|
市区町村
|
contact.billing_address.city | string |
市区町村。 |
|
State
|
contact.billing_address.state | string |
都道府県。 |
|
ZIPファイル
|
contact.billing_address.zip | string |
郵便番号。 |
|
Country
|
contact.billing_address.country | string |
国。 |
|
ファクス
|
contact.billing_address.fax | string |
FAX 番号。 |
|
電話
|
contact.billing_address.phone | string |
電話番号。 |
|
注目
|
contact.shipping_address.attention | string |
アテンション名。 |
|
住所
|
contact.shipping_address.address | string |
アドレス。 |
|
Street
|
contact.shipping_address.street2 | string |
番地。 |
|
状態コード
|
contact.shipping_address.state_code | string |
状態コード。 |
|
市区町村
|
contact.shipping_address.city | string |
市区町村。 |
|
State
|
contact.shipping_address.state | string |
都道府県。 |
|
ZIPファイル
|
contact.shipping_address.zip | string |
郵便番号。 |
|
Country
|
contact.shipping_address.country | string |
国。 |
|
ファクス
|
contact.shipping_address.fax | string |
FAX 番号。 |
|
電話
|
contact.shipping_address.phone | string |
電話番号。 |
|
フェイスブック
|
contact.facebook | string |
Facebook アカウント。 |
|
ツイッター
|
contact.twitter | string |
Twitter ハンドル。 |
|
連絡先
|
contact.contact_persons | array of object | |
|
Salutation
|
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 |
最後に変更された時刻。 |