InfoQuery
InfoQuery を使用すると、ローコード ソリューションで Resware データを利用してビジネスを自動化できます。 ファイル、ドキュメント、パートナーなどを表示、作成、削除、更新できます。
このコネクタは、次の製品とリージョンで使用できます。
| サービス | クラス | リージョン |
|---|---|---|
| コピロット スタジオ | 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) |
| お問い合わせ | |
|---|---|
| 名前 | InfoQuery のサポート |
| URL | https://infoquery.pro/support/ |
| support@infoquery.pro |
| コネクタ メタデータ | |
|---|---|
| Publisher | InfoQuery LLC |
| Website | https://infoquery.pro/ |
| プライバシー ポリシー | https://infoquery.pro/privacy/ |
| カテゴリ | コンテンツとファイル。データ |
InfoQuery タイトル エクスプローラーを使用すると、Resware システムへの変更を自動化できます。 ファイル、アクション、メモ、ドキュメントなどを追加、削除、または編集できます。
[前提条件]
- API キーが必要です。サインアップする必要があります https://connector.infoquery.pro/
- Resware アカウントも必要です。 接続を形成するには、ユーザー名、パスワード、ポータルの URL が必要です。
資格情報を取得する方法
- https://connector.infoquery.pro/signupに移動し、アカウントを作成します。 ここから選択したサブスクリプションを選択できます。選択後に API キーが提供されます。
- サブスクリプションと価格の詳細については、 https://connector.infoquery.pro/products を参照してください。
- Resware アカウントの詳細は、Resware 管理者によって提供されます。
コネクタの概要
- https://powerautomate.microsoft.comで Power Automate に移動します。
- 新しいフローを作成するか、既存のフローを編集します。
- フローに新しいステップを追加し、InfoQuery タイトル エクスプローラーを検索して、使用可能なすべてのアクションを表示します。
- アクションを選択したら、新しい接続を作成する必要があります。
- 接続名、API キー、Resware ユーザー名、パスワード、ポータル URL を入力します。 ポータルの URL は、 https://portal.infoquery.com/APIの形式である必要があります。
- サポートが必要な場合は、 support@infoquery.pro にお問い合わせいただくか、 https://infoquery.pro/support/ にアクセスしてください。
既知の問題と制限事項
Resware を利用する各ビジネスには、特定のニーズに合わせてカスタマイズする機能があります。 Resware の設定によっては、コネクタが正常に動作するために特定の情報を提供する必要があるアクションがあります。 Resware システムに関する知識が必要です。
一般的なエラーと解決方法
アクションは 200 応答を返す場合がありますが、予想される情報は返されません。 これは、ほとんどの場合、特定の Resware の設定に必要な情報が提供されていないことが原因である可能性があります。 指定した情報は Resware に正常に送信され、200 応答が返されましたが、想定どおりにアクションが発生しなかった可能性があります。 Resware 管理者またはポータルは、アクションを完了するために必要な情報を提供できます。
FAQ
Resware ポータルの URL はどこにありますか?
Resware 管理者がポータルの URL を指定します。
API キーを取得する方法
https://connector.infoquery.pro/signupに移動し、アカウントを作成します。 ここから、選択したサブスクリプションを選択できます。API キーは選択後に提供されます。
接続を作成する
コネクタでは、次の認証の種類がサポートされています。
| デフォルト | 接続を作成するためのパラメーター。 | すべてのリージョン | 共有不可 |
デフォルト
適用対象: すべてのリージョン
接続を作成するためのパラメーター。
これは共有可能な接続ではありません。 電源アプリが別のユーザーと共有されている場合、別のユーザーは新しい接続を明示的に作成するように求められます。
| 名前 | タイプ | Description | 必須 |
|---|---|---|---|
| API キー | securestring | この API の API キー | 正しい |
| ResWare ユーザー名 | 文字列 | ResWare のユーザー名 | 正しい |
| ResWare パスワード | securestring | ResWare のパスワード | 正しい |
| ResWare ポータルの URL | 文字列 | ResWare のポータル URL | 正しい |
調整制限
| 名前 | 呼び出し | 更新期間 |
|---|---|---|
| 接続ごとの API 呼び出し | 100 | 60 秒 |
アクション
| Web URL ドキュメントを特定のファイルにアップロードする |
指定したファイルに Web URL ドキュメントを読み込みます。 |
| ドキュメントを取得する |
指定した ID を持つドキュメントに関する情報を取得します。 |
| パートナー企業に新しいパートナー従業員を追加する |
パートナー企業に新しいパートナー従業員を追加します。 |
| パートナー従業員の更新 |
パートナー従業員の情報を更新します。 |
| パートナー情報の取得 |
指定した ID を持つパートナーに関する情報を取得します。 |
| ファイルにアクションを追加する |
指定したファイルにアクションを追加します。 |
| ファイルにメモを追加する |
指定したファイルに新しいメモを追加します。 |
| ファイルの更新アクション |
特定のファイルのアクションを更新します。 アクション グループ ID と、開始/完了コーディネーターの種類 ID、パートナーの種類 ID、期限、期限のロック、および完了日のロックを更新できます。 この API 呼び出しを使用して、アクションを開始または完了としてマークすることはできません。 |
| メモを取得する |
指定した ID のメモを取得します。 |
| 以前に注文した注文を削除する |
以前に注文した注文を取り消します。 |
| 以前に注文した注文を取り消します |
以前に注文した注文を取り消します。 |
| 指定された検索条件からファイルを取得します |
指定された検索条件に基づいて、ファイルとその情報の一覧を取得します。 |
| 新しいファイルの作成 |
新しいファイルを作成します。 |
| 決算手数料の見積もり |
決算手数料を見積もります。 |
| 決算手数料見積もり領収書を取得する |
決算手数料の見積もり領収書を取得します。 |
| 決算手数料見積り領収書の取得 PDF |
PDF 形式の決算手数料見積もり領収書を取得します。 |
| 特定のドキュメントのユーザー設定フィールドを取得する |
指定したドキュメントのユーザー設定フィールドを取得します。 |
| 特定のドキュメントのユーザー設定フィールドを追加または更新する |
指定したファイルの指定したドキュメントのユーザー設定フィールドを追加または更新します。 |
| 特定のファイルでパートナーを削除する |
指定したファイルからパートナーを削除します。 |
| 特定のファイルにパートナーを追加する |
指定したファイルにパートナーを追加します。 |
| 特定のファイルに新しいドキュメントを作成する |
指定したファイルに新しいドキュメントを作成します。 |
| 特定のファイルのアクションを取得する |
指定したファイルに対するすべてのアクションを取得します。 |
| 特定のファイルのドキュメントを取得する |
指定したファイルのドキュメントに関するすべての情報を取得します。 |
| 特定のファイルのパーティを取得する |
指定したファイルの関係者とその情報の一覧を取得します。 |
| 特定のファイルのパートナーを取得する |
指定したファイルに関するパートナーとその情報の一覧を取得します。 |
| 特定のファイルのパートナー情報を更新する |
指定したファイルのパートナー情報を更新します。 |
| 特定のファイルのメモを取得する |
指定したファイルのメモの一覧を取得します。 |
| 特定のファイルのユーザー設定フィールドを取得する |
指定したファイルのユーザー設定フィールドを取得します。 |
| 特定のファイルのユーザー設定フィールドを追加または更新する |
指定したファイルのユーザー設定フィールドを追加または更新します。 |
| 現在のユーザー情報を取得する |
現在接続されているユーザーに関する情報を取得します。 |
| 見積と注文の配置のためにトランザクションと製品の種類を取得する |
手数料の見積もりと注文のトランザクションの種類と製品の種類を取得します。 |
Web URL ドキュメントを特定のファイルにアップロードする
指定したファイルに Web URL ドキュメントを読み込みます。
パラメーター
| 名前 | キー | 必須 | 型 | 説明 |
|---|---|---|---|---|
|
ファイル ID
|
FileID | True | string |
ファイル識別番号。 |
|
ドキュメント名
|
DocumentName | string |
ドキュメント名。 |
|
|
DocumentTypeID
|
DocumentTypeID | integer |
ドキュメントの種類の識別番号。 |
|
|
Description
|
Description | string |
ドキュメントの説明。 |
|
|
InternalOnly
|
InternalOnly | boolean |
ドキュメントが内部のみであるかどうか。 |
|
|
WebURL
|
WebURL | string |
ドキュメントの Web URL。 |
戻り値
| 名前 | パス | 型 | 説明 |
|---|---|---|---|
|
DocumentID
|
Document.DocumentID | integer |
ドキュメント ID 番号。 |
ドキュメントを取得する
指定した ID を持つドキュメントに関する情報を取得します。
パラメーター
| 名前 | キー | 必須 | 型 | 説明 |
|---|---|---|---|---|
|
ドキュメント ID
|
DocumentID | True | string |
ドキュメント ID 番号。 |
戻り値
| 名前 | パス | 型 | 説明 |
|---|---|---|---|
|
DocumentID
|
DocumentID | integer |
ドキュメント ID 番号。 |
|
ドキュメント名
|
DocumentName | string |
ドキュメント名。 |
|
DocumentTypeID
|
DocumentType.DocumentTypeID | integer |
ドキュメントの種類の名前。 |
|
名前
|
DocumentType.Name | string |
ドキュメントの種類の名前。 |
|
Description
|
Description | string |
ドキュメントの説明。 |
|
InternalOnly
|
InternalOnly | boolean |
ドキュメントが内部のみであるかどうか。 |
|
承認済み
|
Approved | boolean |
ドキュメントが承認されているかどうか。 |
|
UserID
|
CreateUser.UserID | integer |
ユーザー ID 番号。 |
|
CreateDate
|
CreateDate | string |
ドキュメントが作成された日付。 |
パートナー企業に新しいパートナー従業員を追加する
パートナー企業に新しいパートナー従業員を追加します。
パラメーター
| 名前 | キー | 必須 | 型 | 説明 |
|---|---|---|---|---|
|
パートナーの会社 ID
|
PartnerCompanyID | True | string |
パートナー企業 ID 番号。 |
|
パスワード
|
Password | string |
新しい従業員のパスワード。 |
|
|
PasswordExpirationDate
|
PasswordExpirationDate | string |
パスワードの有効期限が切れる日付。 |
|
|
Enabled
|
Enabled | boolean |
新しい従業員が使用を有効にするかどうか。 |
|
|
WebsiteAccess
|
WebsiteAccess | boolean |
新しい従業員が Web サイトにアクセスできるかどうか。 |
|
|
名前
|
Name | string |
新しい従業員のフル ネーム。 |
|
|
ファーストネーム
|
FirstName | string |
新しい従業員の名。 |
|
|
LastName
|
LastName | string |
新しい従業員の姓。 |
|
|
メールアドレス
|
EmailAddress | string |
新しい従業員の電子メール アドレス。 |
戻り値
| 名前 | パス | 型 | 説明 |
|---|---|---|---|
|
PartnerCompanyID
|
Employee.PartnerCompanyID | integer |
パートナー企業 ID 番号。 |
|
Enabled
|
Employee.Enabled | boolean |
新しい従業員の使用が有効になっているかどうか。 |
|
WebsiteAccess
|
Employee.WebsiteAccess | boolean |
従業員が Web サイトにアクセスできるかどうか。 |
|
UserID
|
Employee.UserID | integer |
新しい従業員の ID 番号。 |
|
名前
|
Employee.Name | string |
従業員の氏名。 |
|
ファーストネーム
|
Employee.FirstName | string |
従業員の名。 |
|
LastName
|
Employee.LastName | string |
従業員の姓。 |
|
メールアドレス
|
Employee.ContactInformation.EmailAddress | string |
従業員の電子メール アドレス。 |
パートナー従業員の更新
パートナー従業員の情報を更新します。
パラメーター
| 名前 | キー | 必須 | 型 | 説明 |
|---|---|---|---|---|
|
ユーザーID
|
UserID | True | string |
ユーザー ID 番号。 |
|
パートナーの会社 ID
|
PartnerCompanyID | True | string |
パートナー企業 ID 番号。 |
|
パスワード
|
Password | string |
従業員のパスワード。 |
|
|
PasswordExpirationDate
|
PasswordExpirationDate | string |
パスワードの有効期限が切れる日付。 |
|
|
RoleID
|
RoleID | integer |
ロール ID 番号。 |
|
|
名前
|
Name | string |
ロールの名前。 |
|
|
Enabled
|
Enabled | boolean |
従業員が使用を有効にされているかどうか。 |
|
|
WebsiteAccess
|
WebsiteAccess | boolean |
従業員が Web サイトにアクセスできるかどうか。 |
|
|
名前
|
Name | string |
従業員の氏名。 |
|
|
ファーストネーム
|
FirstName | string |
従業員の名。 |
|
|
LastName
|
LastName | string |
従業員の姓。 |
|
|
メールアドレス
|
EmailAddress | string |
従業員の電子メール アドレス。 |
戻り値
| 名前 | パス | 型 | 説明 |
|---|---|---|---|
|
PartnerCompanyID
|
Employee.PartnerCompanyID | integer |
パートナー企業 ID 番号。 |
|
役割
|
Employee.Roles | array of object |
従業員の役割。 |
|
RoleID
|
Employee.Roles.RoleID | integer |
ロール ID 番号。 |
|
名前
|
Employee.Roles.Name | string |
ロールの名前。 |
|
Enabled
|
Employee.Enabled | boolean |
従業員が使用を有効にされているかどうか。 |
|
WebsiteAccess
|
Employee.WebsiteAccess | boolean |
従業員が Web サイトにアクセスできるかどうか。 |
|
UserID
|
Employee.UserID | integer |
ユーザー ID 番号。 |
|
名前
|
Employee.Name | string |
従業員の氏名。 |
|
ファーストネーム
|
Employee.FirstName | string |
従業員の名。 |
|
LastName
|
Employee.LastName | string |
従業員の姓。 |
|
メールアドレス
|
Employee.ContactInformation.EmailAddress | string |
従業員の電子メール アドレス。 |
パートナー情報の取得
指定した ID を持つパートナーに関する情報を取得します。
パラメーター
| 名前 | キー | 必須 | 型 | 説明 |
|---|---|---|---|---|
|
パートナーの会社 ID
|
PartnerCompanyID | True | string |
パートナー企業 ID 番号。 |
戻り値
| 名前 | パス | 型 | 説明 |
|---|---|---|---|
|
PartnerCompanyID
|
PartnerCompanyID | integer |
パートナー企業 ID 番号。 |
|
PartnerTypes
|
PartnerTypes | array of object |
パートナーの種類に関する情報。 |
|
PartnerTypeID
|
PartnerTypes.PartnerTypeID | integer |
パートナーの種類の ID 番号。 |
|
PartnerTypeName
|
PartnerTypes.PartnerTypeName | string |
パートナーの種類名。 |
|
OfficeID
|
OfficeID | integer |
オフィス ID 番号。 |
|
PartnerName
|
PartnerName | string |
パートナー名。 |
|
CompanyAbbreviation
|
CompanyAbbreviation | string |
会社の省略形。 |
|
ProperCompanyName
|
ProperCompanyName | string |
完全な会社名。 |
|
Address1
|
MailingAddress.Address1 | string |
番地と名前。 |
|
Address2
|
MailingAddress.Address2 | string |
詳細な住所情報。 |
|
市区町村
|
MailingAddress.City | string |
市区町村名。 |
|
State
|
MailingAddress.State | string |
2 文字の状態の省略形。 |
|
ZIPファイル
|
MailingAddress.Zip | string |
郵便番号。 |
|
電話番号
|
ContactInformation.PhoneNumber | string |
パートナーの電話番号。 |
|
HomePhoneNumber
|
ContactInformation.HomePhoneNumber | string |
パートナーの自宅の電話番号。 |
|
CellPhoneNumber
|
ContactInformation.CellPhoneNumber | string |
パートナーの携帯電話番号。 |
|
ボイスメール
|
ContactInformation.Voicemail | string |
パートナーボイスメール番号。 |
|
FaxNumber
|
ContactInformation.FaxNumber | string |
パートナー FAX 番号。 |
|
メールアドレス
|
ContactInformation.EmailAddress | string |
パートナーのメール アドレス。 |
|
PreferredCommunicationMethod
|
ContactInformation.PreferredCommunicationMethod | string |
パートナーはコミュニケーションの方法を優先しました。 |
|
Website
|
ContactInformation.Website | string |
パートナー Web サイトの URL。 |
|
ID
|
CompanyInformation.ParentCompany.ID | integer |
識別番号。 |
|
名前
|
CompanyInformation.ParentCompany.Name | string |
親の会社名。 |
|
ID
|
CompanyInformation.PartnerEntity.ID | integer |
識別番号。 |
|
名前
|
CompanyInformation.PartnerEntity.name | string |
パートナー エンティティ名。 |
|
IsBillable
|
CompanyInformation.IsBillable | boolean |
パートナーが課金対象かどうか。 |
|
IsInvoiceable
|
CompanyInformation.IsInvoiceable | boolean |
プロパティが請求可能かどうか。 |
|
TaxID
|
CompanyInformation.TaxID | string |
パートナーの税識別番号。 |
|
AccountingCode
|
CompanyInformation.AccountingCode | string |
会計コード。 |
|
CommentsSpecialInstructions
|
CompanyInformation.CommentsSpecialInstructions | string |
パートナーに関するコメント。 |
|
DontAllowSelectionInSettlement
|
CompanyInformation.DontAllowSelectionInSettlement | boolean |
決済での選択を許可するかどうかを指定します。 |
|
Needs1099
|
CompanyInformation.Needs1099 | boolean |
1099 が必要かどうか。 |
|
MWBE
|
CompanyInformation.MWBE | boolean |
パートナーが MWBE であるかどうか。 |
|
SendDocumentsAsWebLinks
|
SendDocumentsAsWebLinks | boolean |
ドキュメントを Web リンクとして送信するかどうか。 |
|
WireConfirmationEmailTemplateID
|
WireConfirmationEmailTemplateID | integer |
ワイヤ確認テンプレートの識別番号。 |
|
UseOnDisbursements
|
CourierAddress.UseOnDisbursements | boolean |
これが支払いに使用されるかどうか。 |
|
Address1
|
CourierAddress.Address1 | string |
番地と名前。 |
|
Address2
|
CourierAddress.Address2 | string |
詳細な住所情報。 |
|
市区町村
|
CourierAddress.City | string |
市区町村名。 |
|
State
|
CourierAddress.State | string |
2 文字の状態の省略形。 |
|
ZIPファイル
|
CourierAddress.Zip | string |
郵便番号。 |
ファイルにアクションを追加する
指定したファイルにアクションを追加します。
パラメーター
| 名前 | キー | 必須 | 型 | 説明 |
|---|---|---|---|---|
|
ファイル ID
|
FileID | True | string |
ファイル識別番号。 |
|
ActionTypeID
|
ActionTypeID | integer |
アクションの種類の識別番号。 |
|
|
ActionGroupID
|
ActionGroupID | integer |
アクション グループの識別番号。 |
|
|
CoordinatorTypeID
|
CoordinatorTypeID | integer |
コーディネーターの種類の識別番号。 |
|
|
納期
|
DueDate | string |
アクションの期限。 |
|
|
PartnerTypeID
|
PartnerTypeID | integer |
パートナーの種類の ID 番号。 |
|
|
納期
|
DueDate | string |
アクションの期限。 |
戻り値
| 名前 | パス | 型 | 説明 |
|---|---|---|---|
|
FileActionID
|
FileActionID | integer |
ファイル アクションの識別番号。 |
ファイルにメモを追加する
指定したファイルに新しいメモを追加します。
パラメーター
| 名前 | キー | 必須 | 型 | 説明 |
|---|---|---|---|---|
|
ファイル ID
|
FileID | True | string |
ファイル識別番号。 |
|
サブジェクト
|
Subject | string |
ノートの件名。 |
|
|
Body
|
Body | string |
メモ本文。 |
戻り値
| 名前 | パス | 型 | 説明 |
|---|---|---|---|
|
NoteID
|
note.NoteID | integer |
メモの識別番号。 |
ファイルの更新アクション
特定のファイルのアクションを更新します。 アクション グループ ID と、開始/完了コーディネーターの種類 ID、パートナーの種類 ID、期限、期限のロック、および完了日のロックを更新できます。 この API 呼び出しを使用して、アクションを開始または完了としてマークすることはできません。
パラメーター
| 名前 | キー | 必須 | 型 | 説明 |
|---|---|---|---|---|
|
ファイル ID
|
FileID | True | string |
ファイル識別番号。 |
|
ファイル アクション ID
|
FileActionID | True | string |
アクションの識別番号。 |
|
CoordinatorTypeID
|
CoordinatorTypeID | integer |
コーディネーターの種類の識別番号。 |
|
|
納期
|
DueDate | string |
アクションの期限。 |
|
|
DoneDateLocked
|
DoneDateLocked | boolean |
完了日がロックされているかどうか。 |
|
|
CoordinatorTypeID
|
CoordinatorTypeID | integer |
コーディネーターの種類の識別番号。 |
|
|
納期
|
DueDate | string |
アクションの期限。 |
|
|
DoneDateLocked
|
DoneDateLocked | boolean |
完了日がロックされているかどうか。 |
戻り値
| 名前 | パス | 型 | 説明 |
|---|---|---|---|
|
FileActionID
|
FileActionID | integer |
アクションの識別番号。 |
メモを取得する
指定した ID のメモを取得します。
パラメーター
| 名前 | キー | 必須 | 型 | 説明 |
|---|---|---|---|---|
|
メモ ID
|
NoteID | True | string |
識別番号をメモします。 |
戻り値
| 名前 | パス | 型 | 説明 |
|---|---|---|---|
|
NoteID
|
NoteID | integer |
メモの識別番号。 |
|
サブジェクト
|
Subject | string |
ノートの件名。 |
|
Body
|
Body | string |
メモ本文。 |
|
UserID
|
CreatedBy.UserID | integer |
ユーザー ID 番号。 |
|
CreatedDate
|
CreatedDate | string |
メモが作成された日付。 |
|
FileID
|
FileID | integer |
ファイル識別番号。 |
以前に注文した注文を削除する
以前に注文した注文を取り消します。
パラメーター
| 名前 | キー | 必須 | 型 | 説明 |
|---|---|---|---|---|
|
ファイル ID
|
FileID | True | string |
ファイル識別番号。 |
|
FileID
|
FileID | integer |
ファイル識別番号。 |
戻り値
- response
- object
以前に注文した注文を取り消します
以前に注文した注文を取り消します。
パラメーター
| 名前 | キー | 必須 | 型 | 説明 |
|---|---|---|---|---|
|
ファイル ID
|
FileID | True | string |
ファイル識別番号。 |
|
FileID
|
FileID | integer |
ファイル識別番号。 |
戻り値
- response
- object
指定された検索条件からファイルを取得します
指定された検索条件に基づいて、ファイルとその情報の一覧を取得します。
パラメーター
| 名前 | キー | 必須 | 型 | 説明 |
|---|---|---|---|---|
|
FileNumber
|
FileNumber | string |
ファイル番号。 |
|
|
FileID
|
FileID | integer |
ファイル識別番号。 |
|
|
OfficeID
|
OfficeID | integer |
オフィス ID 番号。 |
|
|
ClientsFileNumber
|
ClientsFileNumber | string |
クライアント ファイル番号。 |
|
|
TransactionTypeID
|
TransactionTypeID | integer |
トランザクションの種類の識別番号。 |
|
|
ProductTypeID
|
ProductTypeID | integer |
製品の種類の識別番号。 |
|
|
StatusID
|
StatusID | integer |
状態 ID 番号。 |
|
|
名前
|
Name | string |
状態の名前。 |
|
|
PolicyNumber
|
PolicyNumber | string |
ポリシー番号。 |
|
|
SearchNumber
|
SearchNumber | string |
検索番号。 |
|
|
LoanNumber
|
LoanNumber | string |
ローン番号。 |
|
|
IsPrimary
|
IsPrimary | boolean |
これがプライマリ プロパティ アドレスかどうか。 |
|
|
StreetNumber
|
StreetNumber | string |
番地。 |
|
|
StreetName
|
StreetName | string |
番地の名前。 |
|
|
市区町村
|
City | string |
市区町村名。 |
|
|
State
|
State | string |
2 文字の状態の省略形。 |
|
|
ZIPファイル
|
Zip | string |
郵便番号。 |
|
|
小分け
|
Subdivision | string |
プロパティが配置されている下位区分。 |
|
|
ParcelID
|
ParcelID | string |
パーセル ID 番号。 |
|
|
EntityType
|
EntityType | string |
エンティティ型。 |
|
|
First
|
First | string |
パーティーの名。 |
|
|
Last
|
Last | string |
パーティーの姓。 |
|
|
UsePropertyAddress
|
UsePropertyAddress | boolean |
これがプライマリ プロパティ アドレスかどうか。 |
|
|
MaritalStatus
|
MaritalStatus | string |
パーティーの婚活状態。 |
|
|
UserID
|
UserID | integer |
ユーザー ID 番号。 |
|
|
PartnerTypeID
|
PartnerTypeID | integer |
パートナーの種類の ID 番号。 |
|
|
パートナーID
|
PartnerID | integer |
パートナー ID 番号。 |
|
|
PartnerTypeID
|
PartnerTypeID | integer |
パートナーの種類の ID 番号。 |
|
|
OpenedFromDate
|
OpenedFromDate | string |
ファイルが開かれた日付。 |
|
|
OpenedToDate
|
OpenedToDate | string |
ファイルが閉じられた日付。 |
戻り値
- response
- object
新しいファイルの作成
新しいファイルを作成します。
パラメーター
| 名前 | キー | 必須 | 型 | 説明 |
|---|---|---|---|---|
|
EntityType
|
EntityType | string |
エンティティ型の名前。 個人、法人等 |
|
|
IsPrimaryTransactee
|
IsPrimaryTransactee | boolean |
買い手が主な取引人かどうか。 |
|
|
First
|
First | string |
購入者の名。 |
|
|
Last
|
Last | string |
購入者の姓。 |
|
|
UsePropertyAddress
|
UsePropertyAddress | boolean |
郵送先住所を新しいファイルのプロパティ アドレスとして使用するかどうかを指定します。 |
|
|
Address1
|
Address1 | string |
番地と名前。 |
|
|
市区町村
|
City | string |
市区町村名。 |
|
|
State
|
State | string |
2 文字の状態の省略形。 |
|
|
ZIPファイル
|
Zip | string |
郵便番号。 |
|
|
MaritalStatus
|
MaritalStatus | string |
購入者の結婚状態。 |
|
|
Email
|
string |
購入者のメール アドレス。 |
||
|
EntityType
|
EntityType | string |
エンティティ型の名前。 個人、法人等 |
|
|
IsPrimaryTransactee
|
IsPrimaryTransactee | boolean |
販売者が主な取引先かどうか。 |
|
|
First
|
First | string |
販売者の名。 |
|
|
Last
|
Last | string |
販売者の姓。 |
|
|
UsePropertyAddress
|
UsePropertyAddress | boolean |
郵送先住所を新しいファイルのプロパティ アドレスとして使用するかどうかを指定します。 |
|
|
Address1
|
Address1 | string |
番地と名前。 |
|
|
市区町村
|
City | string |
市区町村名。 |
|
|
State
|
State | string |
2 文字の状態の省略形。 |
|
|
ZIPファイル
|
Zip | string |
郵便番号。 |
|
|
MaritalStatus
|
MaritalStatus | string |
販売者の婚活状態。 |
|
|
Email
|
string |
販売者のメール アドレス。 |
||
|
EstimatedSettlementDate
|
EstimatedSettlementDate | string |
注文の推定受渡日。 |
|
|
TransactionTypeID
|
TransactionTypeID | integer |
トランザクションの種類の識別番号。 |
|
|
ProductTypeID
|
ProductTypeID | integer |
製品の種類の識別番号。 |
|
|
SalesPrice
|
SalesPrice | integer |
プロパティの販売価格。 |
|
|
ClientFileNumber
|
ClientFileNumber | string |
クライアント ファイル番号。 |
|
|
PiggybackFileNumber
|
PiggybackFileNumber | string |
ピギーバック ファイル番号。 |
|
|
MainFileNumber
|
MainFileNumber | string |
メイン ファイル番号。 |
|
|
SourceOfBusinessID
|
SourceOfBusinessID | integer |
ビジネス ID 番号のソース。 |
|
|
注
|
Note | string |
新しいファイルに追加するメモ。 |
|
|
名前
|
Name | string |
ユーザー設定フィールドの名前。 |
|
|
価値
|
Value | string |
ユーザー設定フィールドの値 |
|
|
LienPosition
|
LienPosition | integer |
lien 位置。 |
|
|
LoanNumber
|
LoanNumber | string |
ローン番号。 |
|
|
LoanAmount
|
LoanAmount | integer |
ローンの金額。 |
|
|
LoanType
|
LoanType | string |
ローンの種類。 |
|
|
IsPrimary
|
IsPrimary | boolean |
これがプライマリ プロパティ アドレスかどうか。 |
|
|
StreetNumber
|
StreetNumber | string |
番地。 |
|
|
StreetName
|
StreetName | string |
番地の名前。 |
|
|
市区町村
|
City | string |
市区町村名。 |
|
|
State
|
State | string |
2 文字の状態の省略形。 |
|
|
郡
|
County | string |
宿泊施設が位置する郡。 |
|
|
ZIPファイル
|
Zip | string |
郵便番号。 |
戻り値
| 名前 | パス | 型 | 説明 |
|---|---|---|---|
|
FileID
|
FileID | integer |
新しいファイルの識別番号。 |
|
FileNumber
|
FileNumber | string |
新しいファイルのファイル番号。 |
|
Warnings
|
Warnings | array of string |
新しいファイルに関する警告。 |
決算手数料の見積もり
決算手数料を見積もります。
パラメーター
| 名前 | キー | 必須 | 型 | 説明 |
|---|---|---|---|---|
|
TransactionTypeID
|
TransactionTypeID | integer |
トランザクションの種類の識別番号。 |
|
|
ProductTypeID
|
ProductTypeID | integer |
製品の種類の識別番号。 |
|
|
SettlementStatementVersion
|
SettlementStatementVersion | string |
決済明細書のバージョン。 |
|
|
SalesPrice
|
SalesPrice | integer |
販売価格。 |
|
|
LienPosition
|
LienPosition | integer |
lien 位置。 |
|
|
LoanAmount
|
LoanAmount | integer |
ローン金額。 |
|
|
LoanType
|
LoanType | string |
ローンの種類。 |
|
|
IsPrimary
|
IsPrimary | boolean |
これがプライマリ プロパティかどうか。 |
|
|
StreetNumber
|
StreetNumber | string |
番地。 |
|
|
StreetName
|
StreetName | string |
番地の名前。 |
|
|
市区町村
|
City | string |
市区町村名。 |
|
|
State
|
State | string |
2 文字の状態の省略形。 |
|
|
郡
|
County | string |
郡名。 |
|
|
ZIPファイル
|
Zip | string |
郵便番号。 |
|
|
PartnerTypeID
|
PartnerTypeID | integer |
パートナーの種類の ID 番号。 |
|
|
パートナーID
|
PartnerID | integer |
パートナー ID 番号。 |
|
|
PartnerTypeID
|
PartnerTypeID | integer |
パートナーの種類の ID 番号。 |
|
|
名前
|
Name | string |
保証の名前。 |
戻り値
| 名前 | パス | 型 | 説明 |
|---|---|---|---|
|
ClosingFeeEstimateID
|
ClosingFeeEstimate.ClosingFeeEstimateID | integer |
決算手数料見積もり識別番号。 |
|
HUDFees
|
ClosingFeeEstimate.HUDFees | array of object |
HUD 料金。 |
|
金額
|
ClosingFeeEstimate.HUDFees.Amount | integer |
HUD 料金の金額。 |
|
Description
|
ClosingFeeEstimate.HUDFees.Description | string |
料金の説明。 |
|
LineNumber
|
ClosingFeeEstimate.HUDFees.LineNumber | string |
行番号。 |
|
BuyerAmount
|
ClosingFeeEstimate.HUDFees.BuyerAmount | integer |
購入者の金額。 |
|
BuyerPOCAmount
|
ClosingFeeEstimate.HUDFees.BuyerPOCAmount | integer |
購入者 POC の金額。 |
|
SellerAmount
|
ClosingFeeEstimate.HUDFees.SellerAmount | integer |
販売者の金額。 |
|
SellerPOCAmount
|
ClosingFeeEstimate.HUDFees.SellerPOCAmount | integer |
販売者 POC の金額。 |
|
OtherPOCAmount
|
ClosingFeeEstimate.HUDFees.OtherPOCAmount | integer |
その他の POC 量。 |
|
PartnerTypeID
|
ClosingFeeEstimate.HUDFees.OtherPOCPartnerType.PartnerTypeID | integer |
パートナーの種類の ID 番号。 |
|
PartnerTypeName
|
ClosingFeeEstimate.HUDFees.OtherPOCPartnerType.PartnerTypeName | string |
パートナーの種類名。 |
|
GFE
|
ClosingFeeEstimate.GFE | array of object |
誠実な見積もり。 |
|
Description
|
ClosingFeeEstimate.GFE.Description | string |
見積もりの対象。 |
|
金額
|
ClosingFeeEstimate.GFE.Amount | integer |
見積もりの量。 |
|
LendersPremium
|
ClosingFeeEstimate.Premiums.LendersPremium | integer |
貸し手プレミアム。 |
|
FullLendersPremium
|
ClosingFeeEstimate.Premiums.FullLendersPremium | integer |
完全な貸し手プレミアム。 |
|
タイムスタンプ
|
ClosingFeeEstimate.Timestamp | string |
タイムスタンプ。 |
決算手数料見積もり領収書を取得する
決算手数料の見積もり領収書を取得します。
パラメーター
| 名前 | キー | 必須 | 型 | 説明 |
|---|---|---|---|---|
|
決算手数料 ID
|
ClosingFeeID | True | string |
決算手数料の識別番号。 |
戻り値
| 名前 | パス | 型 | 説明 |
|---|---|---|---|
|
EstimateDate
|
EstimateDate | string |
見積もりの日付。 |
|
TransactionTypeID
|
Request.TransactionProductType.TransactionTypeID | integer |
トランザクションの種類の識別番号。 |
|
ProductTypeID
|
Request.TransactionProductType.ProductTypeID | integer |
製品の種類の識別番号。 |
|
SettlementStatementVersion
|
Request.SettlementStatementVersion | string |
決済明細書のバージョン。 |
|
SalesPrice
|
Request.SalesPrice | integer |
販売価格。 |
|
ローン
|
Request.Loans | array of object |
ローンに関する情報。 |
|
LienPosition
|
Request.Loans.LienPosition | integer |
lien 位置。 |
|
LoanAmount
|
Request.Loans.LoanAmount | integer |
ローン金額。 |
|
LoanType
|
Request.Loans.LoanType | string |
ローンの種類。 |
|
プロパティ
|
Request.Properties | array of object |
見積もりのプロパティ。 |
|
IsPrimary
|
Request.Properties.IsPrimary | boolean |
これがプライマリ プロパティかどうか。 |
|
StreetNumber
|
Request.Properties.StreetNumber | string |
番地。 |
|
StreetName
|
Request.Properties.StreetName | string |
番地の名前。 |
|
市区町村
|
Request.Properties.City | string |
市区町村名。 |
|
State
|
Request.Properties.State | string |
2 文字の状態の省略形。 |
|
郡
|
Request.Properties.County | string |
郡名。 |
|
ZIPファイル
|
Request.Properties.Zip | string |
郵便番号。 |
|
FilePartners
|
Request.FilePartners | array of object |
ファイル上のパートナー。 |
|
PartnerTypeID
|
Request.FilePartners.PartnerTypeID | integer |
パートナーの種類の ID 番号。 |
|
パートナーID
|
Request.FilePartners.PartnerID | integer |
パートナー ID 番号。 |
|
PartnerTypeID
|
Request.FilePartners.PartnerType.PartnerTypeID | integer |
パートナーの種類の ID 番号。 |
|
保証
|
Request.Endorsements | array of object |
保証。 |
|
名前
|
Request.Endorsements.Name | string |
保証の名前。 |
|
ClosingFeeEstimateID
|
Response.ClosingFeeEstimateID | integer |
決算手数料見積もり識別番号。 |
|
HUDFees
|
Response.HUDFees | array of object |
HUD 料金。 |
|
金額
|
Response.HUDFees.Amount | integer |
HUD 料金の金額。 |
|
Description
|
Response.HUDFees.Description | string |
料金の説明。 |
|
LineNumber
|
Response.HUDFees.LineNumber | string |
行番号。 |
|
BuyerAmount
|
Response.HUDFees.BuyerAmount | integer |
購入者の金額。 |
|
BuyerPOCAmount
|
Response.HUDFees.BuyerPOCAmount | integer |
購入者 POC の金額。 |
|
SellerAmount
|
Response.HUDFees.SellerAmount | integer |
販売者の金額。 |
|
SellerPOCAmount
|
Response.HUDFees.SellerPOCAmount | integer |
販売者 POC の金額。 |
|
OtherPOCAmount
|
Response.HUDFees.OtherPOCAmount | integer |
その他の POC 量。 |
|
PartnerTypeID
|
Response.HUDFees.OtherPOCPartnerType.PartnerTypeID | integer |
パートナーの種類の ID 番号。 |
|
PartnerTypeName
|
Response.HUDFees.OtherPOCPartnerType.PartnerTypeName | string |
パートナーの種類名。 |
|
GFE
|
Response.GFE | array of object |
誠実な見積もり。 |
|
Description
|
Response.GFE.Description | string |
見積もりの対象。 |
|
金額
|
Response.GFE.Amount | integer |
見積もりの量。 |
|
LendersPremium
|
Response.Premiums.LendersPremium | integer |
貸し手プレミアム。 |
|
FullLendersPremium
|
Response.Premiums.FullLendersPremium | integer |
完全な貸し手プレミアム。 |
|
タイムスタンプ
|
Response.Timestamp | string |
タイムスタンプ。 |
決算手数料見積り領収書の取得 PDF
PDF 形式の決算手数料見積もり領収書を取得します。
パラメーター
| 名前 | キー | 必須 | 型 | 説明 |
|---|---|---|---|---|
|
決算手数料 ID
|
ClosingFeeID | True | string |
決算手数料の識別番号。 |
戻り値
- response
- object
特定のドキュメントのユーザー設定フィールドを取得する
指定したドキュメントのユーザー設定フィールドを取得します。
パラメーター
| 名前 | キー | 必須 | 型 | 説明 |
|---|---|---|---|---|
|
ファイル ID
|
FileID | True | string |
ファイル識別番号。 |
|
ドキュメント ID
|
DocumentID | True | string |
ドキュメント ID 番号。 |
戻り値
| 名前 | パス | 型 | 説明 |
|---|---|---|---|
|
CustomFields
|
CustomFields | array of object |
ユーザー設定フィールド。 |
|
名前
|
CustomFields.Name | string |
ユーザー設定フィールドの名前。 |
|
価値
|
CustomFields.Value | string |
ユーザー設定フィールドの値。 |
|
CustomFieldListCount
|
CustomFieldListCount | integer |
ファイルのユーザー設定フィールドの数。 |
特定のドキュメントのユーザー設定フィールドを追加または更新する
指定したファイルの指定したドキュメントのユーザー設定フィールドを追加または更新します。
パラメーター
| 名前 | キー | 必須 | 型 | 説明 |
|---|---|---|---|---|
|
ファイル ID
|
FileID | True | string |
ファイル識別番号。 |
|
ドキュメント ID
|
DocumentID | True | string |
ドキュメント ID 番号。 |
|
名前
|
Name | string |
ユーザー設定フィールドの名前。 |
|
|
価値
|
Value | string |
ユーザー設定フィールドの値。 |
戻り値
- response
- object
特定のファイルでパートナーを削除する
指定したファイルからパートナーを削除します。
パラメーター
| 名前 | キー | 必須 | 型 | 説明 |
|---|---|---|---|---|
|
ファイル ID
|
FileID | True | string |
ファイル識別番号。 |
|
PartnerTypeID
|
PartnerTypeID | integer |
パートナーの種類の ID 番号。 |
|
|
パートナーID
|
PartnerID | integer |
パートナー ID 番号。 |
|
|
PartnerTypeID
|
PartnerTypeID | integer |
パートナーの種類の ID 番号。 |
戻り値
- response
- object
特定のファイルにパートナーを追加する
指定したファイルにパートナーを追加します。
パラメーター
| 名前 | キー | 必須 | 型 | 説明 |
|---|---|---|---|---|
|
ファイル ID
|
FileID | True | string |
ファイル識別番号。 |
|
UserID
|
UserID | integer |
ユーザー ID 番号。 |
|
|
UserID
|
UserID | integer |
ユーザー ID 番号。 |
|
|
PartnerTypeID
|
PartnerTypeID | integer |
パートナーの種類の ID 番号。 |
|
|
パートナーID
|
PartnerID | integer |
パートナー ID 番号。 |
|
|
PartnerTypeID
|
PartnerTypeID | integer |
パートナーの種類の ID 番号。 |
戻り値
- response
- object
特定のファイルに新しいドキュメントを作成する
指定したファイルに新しいドキュメントを作成します。
パラメーター
| 名前 | キー | 必須 | 型 | 説明 |
|---|---|---|---|---|
|
ファイル ID
|
FileID | True | string |
ファイル識別番号。 |
|
ドキュメント名
|
DocumentName | string |
ドキュメント名。 |
|
|
DocumentTypeID
|
DocumentTypeID | integer |
ドキュメントの種類の識別番号。 |
|
|
Description
|
Description | string |
ドキュメントの説明。 |
|
|
InternalOnly
|
InternalOnly | string |
ドキュメントが内部のみであるかどうか。 |
|
|
ドキュメント本文
|
DocumentBody | string |
ドキュメント本文。 |
戻り値
| 名前 | パス | 型 | 説明 |
|---|---|---|---|
|
DocumentID
|
Document.DocumentID | integer |
ドキュメント ID 番号。 |
特定のファイルのアクションを取得する
指定したファイルに対するすべてのアクションを取得します。
パラメーター
| 名前 | キー | 必須 | 型 | 説明 |
|---|---|---|---|---|
|
ファイル ID
|
FileID | True | string |
ファイル識別番号。 |
戻り値
| 名前 | パス | 型 | 説明 |
|---|---|---|---|
|
アクション
|
Actions | array of object |
アクションの一覧。 |
|
FileActionID
|
Actions.FileActionID | integer |
ファイル アクションの識別番号。 |
|
ActionTypeID
|
Actions.ActionType.ActionTypeID | integer |
アクションの種類の識別番号。 |
|
名前
|
Actions.ActionType.Name | string |
アクション名。 |
|
DisplayName
|
Actions.ActionType.DisplayName | string |
表示名。 |
|
ActionGroupID
|
Actions.Group.ActionGroupID | integer |
アクション グループの識別番号。 |
|
名前
|
Actions.Group.Name | string |
アクション名。 |
|
CoordinatorTypeID
|
Actions.StartTask.CoordinatorTypeID | integer |
コーディネーターの種類の識別番号。 |
|
納期
|
Actions.StartTask.DueDate | string |
アクションの期限。 |
|
DueDateLocked
|
Actions.StartTask.DueDateLocked | boolean |
期限がロックされているかどうか。 |
|
DoneDate
|
Actions.StartTask.DoneDate | string |
アクションの終了日。 |
|
DoneDateLocked
|
Actions.StartTask.DoneDateLocked | boolean |
完了日がロックされているかどうか。 |
|
UserID
|
Actions.StartTask.DoneBy.UserID | integer |
ユーザー ID 番号。 |
|
名前
|
Actions.StartTask.DoneBy.Name | string |
ユーザー名。 |
|
CoordinatorTypeID
|
Actions.CompleteTask.CoordinatorTypeID | integer |
コーディネーターの種類の識別番号。 |
|
納期
|
Actions.CompleteTask.DueDate | string |
アクションの期限。 |
|
DueDateLocked
|
Actions.CompleteTask.DueDateLocked | boolean |
期限がロックされているかどうか。 |
|
DoneDateLocked
|
Actions.CompleteTask.DoneDateLocked | boolean |
完了日がロックされているかどうか。 |
|
UserID
|
Actions.CompleteTask.DoneBy.UserID | integer |
ユーザー ID 番号。 |
|
名前
|
Actions.CompleteTask.DoneBy.Name | string |
ユーザーの名前です。 |
特定のファイルのドキュメントを取得する
指定したファイルのドキュメントに関するすべての情報を取得します。
パラメーター
| 名前 | キー | 必須 | 型 | 説明 |
|---|---|---|---|---|
|
ファイル ID
|
FileID | True | string |
ファイル識別番号。 |
戻り値
| 名前 | パス | 型 | 説明 |
|---|---|---|---|
|
ドキュメント
|
Documents | array of object |
ファイル上のドキュメントの一覧。 |
|
DocumentID
|
Documents.DocumentID | integer |
ドキュメント ID 番号。 |
|
ドキュメント名
|
Documents.DocumentName | string |
ドキュメント名。 |
|
DocumentTypeID
|
Documents.DocumentType.DocumentTypeID | integer |
ドキュメントの種類の識別番号。 |
|
名前
|
Documents.DocumentType.Name | string |
ドキュメントの種類の名前。 |
|
Description
|
Documents.Description | string |
ドキュメントの説明。 |
|
InternalOnly
|
Documents.InternalOnly | boolean |
ドキュメントが内部のみであるかどうか。 |
|
承認済み
|
Documents.Approved | boolean |
ドキュメントが承認されているかどうか。 |
|
AssociatedNotes
|
Documents.AssociatedNotes | array of object |
ドキュメントに関連付けられているメモ。 |
|
NoteID
|
Documents.AssociatedNotes.NoteID | integer |
識別番号をメモします。 |
|
UserID
|
Documents.CreateUser.UserID | integer |
ユーザー ID 番号。 |
|
名前
|
Documents.CreateUser.Name | string |
ユーザーの名前です。 |
|
CreateDate
|
Documents.CreateDate | string |
ドキュメントが作成された日付。 |
|
UserID
|
Documents.ModifyUser.UserID | integer |
ユーザー ID 番号。 |
|
名前
|
Documents.ModifyUser.Name | string |
ユーザーの名前です。 |
|
ModifyDate
|
Documents.ModifyDate | string |
ドキュメントが変更された日付。 |
特定のファイルのパーティを取得する
指定したファイルの関係者とその情報の一覧を取得します。
パラメーター
| 名前 | キー | 必須 | 型 | 説明 |
|---|---|---|---|---|
|
ファイル ID
|
FileID | True | string |
ファイル識別番号。 |
戻り値
| 名前 | パス | 型 | 説明 |
|---|---|---|---|
|
バイヤー
|
Buyers | array of object |
購入者に関する情報。 |
|
LegalEntityID
|
Buyers.LegalEntityID | integer |
法人 ID 番号。 |
|
EntityType
|
Buyers.EntityType | string |
エンティティ型の名前。 |
|
接頭辞
|
Buyers.Primary.Prefix | string |
購入者のプレフィックス。 |
|
First
|
Buyers.Primary.First | string |
購入者の名。 |
|
中央
|
Buyers.Primary.Middle | string |
購入者のミドル ネーム。 |
|
Last
|
Buyers.Primary.Last | string |
購入者の姓。 |
|
敬称
|
Buyers.Primary.Suffix | string |
購入者のサフィックス。 |
|
接頭辞
|
Buyers.Secondary.Prefix | string |
セカンダリ 購入者のプレフィックス。 |
|
First
|
Buyers.Secondary.First | string |
セカンダリ 購入者の名。 |
|
中央
|
Buyers.Secondary.Middle | string |
セカンダリ 購入者のミドル ネーム。 |
|
Last
|
Buyers.Secondary.Last | string |
セカンダリ 購入者の姓。 |
|
UsePropertyAddress
|
Buyers.UsePropertyAddress | boolean |
アドレスを使用するかどうか。 |
|
Address1
|
Buyers.Address.Address1 | string |
番地と名前。 |
|
市区町村
|
Buyers.Address.City | string |
市区町村名。 |
|
State
|
Buyers.Address.State | string |
2 文字の状態の省略形。 |
|
ZIPファイル
|
Buyers.Address.Zip | string |
郵便番号。 |
|
MaritalStatus
|
Buyers.MaritalStatus | string |
パーティーの婚活状態。 |
|
Email
|
Buyers.Email | string |
パーティーのメール アドレス。 |
|
HomePhone
|
Buyers.HomePhone | string |
パーティーの自宅電話番号。 |
|
EmailSecondary
|
Buyers.EmailSecondary | string |
セカンダリ パーティの電子メール アドレス。 |
|
売り手
|
Sellers | array of object |
販売者に関する情報。 |
|
LegalEntityID
|
Sellers.LegalEntityID | integer |
法人 ID 番号。 |
|
EntityType
|
Sellers.EntityType | string |
エンティティ型。 |
|
BusinessName
|
Sellers.Primary.BusinessName | string |
ビジネス名。 |
|
UsePropertyAddress
|
Sellers.UsePropertyAddress | boolean |
アドレスを使用するかどうか。 |
|
Address1
|
Sellers.Address.Address1 | string |
番地と名前。 |
|
市区町村
|
Sellers.Address.City | string |
市区町村名。 |
|
State
|
Sellers.Address.State | string |
2 文字の状態の省略形。 |
|
ZIPファイル
|
Sellers.Address.Zip | string |
郵便番号。 |
|
MaritalStatus
|
Sellers.MaritalStatus | string |
パーティーの婚活状態。 |
|
Email
|
Sellers.Email | string |
パーティーのメール アドレス。 |
|
顧客
|
Customers | array of string |
顧客に関する情報。 |
特定のファイルのパートナーを取得する
指定したファイルに関するパートナーとその情報の一覧を取得します。
パラメーター
| 名前 | キー | 必須 | 型 | 説明 |
|---|---|---|---|---|
|
ファイル ID
|
FileID | True | string |
ファイル識別番号。 |
戻り値
| 名前 | パス | 型 | 説明 |
|---|---|---|---|
|
Partners
|
Partners | array of object |
パートナーに関する情報。 |
|
UserID
|
Partners.PrimaryEmployee.UserID | integer |
ユーザー ID 番号。 |
|
名前
|
Partners.PrimaryEmployee.Name | string |
従業員の氏名。 |
|
ファーストネーム
|
Partners.PrimaryEmployee.FirstName | string |
従業員の名。 |
|
LastName
|
Partners.PrimaryEmployee.LastName | string |
従業員の姓。 |
|
電話番号
|
Partners.PrimaryEmployee.ContactInformation.PhoneNumber | string |
従業員の電話番号。 |
|
メールアドレス
|
Partners.PrimaryEmployee.ContactInformation.EmailAddress | string |
従業員の電子メール アドレス。 |
|
PartnerTypeID
|
Partners.PartnerTypeID | integer |
パートナーの種類の ID 番号。 |
|
パートナーID
|
Partners.PartnerID | integer |
パートナー ID 番号。 |
|
PartnerTypeID
|
Partners.PartnerType.PartnerTypeID | integer |
パートナーの種類の ID 番号。 |
|
PartnerTypeName
|
Partners.PartnerType.PartnerTypeName | string |
パートナーの種類名。 |
|
PartnerName
|
Partners.PartnerName | string |
パートナー名。 |
特定のファイルのパートナー情報を更新する
指定したファイルのパートナー情報を更新します。
パラメーター
| 名前 | キー | 必須 | 型 | 説明 |
|---|---|---|---|---|
|
ファイル ID
|
FileID | True | string |
ファイル識別番号。 |
|
パートナー ID
|
PartnerID | True | string |
パートナー ID 番号。 |
|
FileID
|
FileID | integer |
ファイル識別番号。 |
|
|
UserID
|
UserID | integer |
ユーザー ID 番号。 |
|
|
名前
|
Name | string |
従業員の氏名。 |
|
|
ファーストネーム
|
FirstName | string |
従業員の名。 |
|
|
LastName
|
LastName | string |
従業員の姓。 |
|
|
電話番号
|
PhoneNumber | string |
従業員の電話番号。 |
|
|
HomePhoneNumber
|
HomePhoneNumber | string |
従業員の自宅電話番号。 |
|
|
CellPhoneNumber
|
CellPhoneNumber | string |
従業員の携帯電話番号。 |
|
|
ボイスメール
|
Voicemail | string |
従業員のボイスメール。 |
|
|
FaxNumber
|
FaxNumber | string |
従業員の FAX 番号。 |
|
|
メールアドレス
|
EmailAddress | string |
従業員の電子メール アドレス。 |
|
|
PreferredCommunicationMethod
|
PreferredCommunicationMethod | string |
従業員はコミュニケーション方法を優先しました。 |
|
|
Website
|
Website | string |
従業員の Web リンク。 |
|
|
UserID
|
UserID | integer |
ユーザー ID 番号。 |
|
|
名前
|
Name | string |
セカンダリ 従業員の完全な名前。 |
|
|
ファーストネーム
|
FirstName | string |
セカンダリ 従業員の名。 |
|
|
LastName
|
LastName | string |
セカンダリ 従業員の姓。 |
|
|
電話番号
|
PhoneNumber | string |
セカンダリ 従業員の電話番号。 |
|
|
HomePhoneNumber
|
HomePhoneNumber | string |
セカンダリ 従業員の自宅の電話番号。 |
|
|
CellPhoneNumber
|
CellPhoneNumber | string |
セカンダリ 従業員の携帯電話番号。 |
|
|
ボイスメール
|
Voicemail | string |
セカンダリ従業員のボイスメール。 |
|
|
FaxNumber
|
FaxNumber | string |
セカンダリ 従業員の FAX 番号。 |
|
|
メールアドレス
|
EmailAddress | string |
セカンダリ 従業員の電子メール アドレス。 |
|
|
PreferredCommunicationMethod
|
PreferredCommunicationMethod | string |
2 次従業員は、コミュニケーション方法を優先しました。 |
|
|
Website
|
Website | string |
セカンダリ 従業員の Web リンク。 |
|
|
ReferenceNumber
|
ReferenceNumber | string |
参照番号。 |
|
|
RemoteFileNumber
|
RemoteFileNumber | string |
リモート ファイル番号。 |
|
|
PartnerTypeID
|
PartnerTypeID | integer |
パートナーの種類の ID 番号。 |
|
|
パートナーID
|
PartnerID | integer |
パートナー ID 番号。 |
|
|
PartnerTypeID
|
PartnerTypeID | integer |
パートナーの種類の ID 番号。 |
|
|
PartnerTypeName
|
PartnerTypeName | string |
パートナーの種類名。 |
|
|
OfficeID
|
OfficeID | integer |
オフィス ID 番号。 |
|
|
PartnerName
|
PartnerName | string |
パートナー名。 |
|
|
Address1
|
Address1 | string |
番地と名前。 |
|
|
Address2
|
Address2 | string |
詳細な住所情報。 |
|
|
市区町村
|
City | string |
市区町村名。 |
|
|
State
|
State | string |
2 文字の状態の省略形。 |
|
|
ZIPファイル
|
Zip | string |
郵便番号。 |
|
|
電話番号
|
PhoneNumber | string |
パートナーの電話番号。 |
|
|
HomePhoneNumber
|
HomePhoneNumber | string |
パートナーの自宅の電話番号。 |
|
|
CellPhoneNumber
|
CellPhoneNumber | string |
パートナーの携帯電話番号。 |
|
|
ボイスメール
|
Voicemail | string |
パートナーボイスメール番号。 |
|
|
FaxNumber
|
FaxNumber | string |
パートナー FAX 番号。 |
|
|
メールアドレス
|
EmailAddress | string |
パートナーのメール アドレス。 |
|
|
PreferredCommunicationMethod
|
PreferredCommunicationMethod | string |
パートナーはコミュニケーションの方法を優先しました。 |
|
|
Website
|
Website | string |
パートナー Web サイトの URL。 |
戻り値
| 名前 | パス | 型 | 説明 |
|---|---|---|---|
|
FileID
|
FileID | integer |
ファイル識別番号。 |
|
FileNumber
|
FileNumber | string |
ファイル番号 |
|
UserID
|
PrimaryEmployee.UserID | integer |
ユーザー ID 番号。 |
|
名前
|
PrimaryEmployee.Name | string |
従業員の氏名。 |
|
ファーストネーム
|
PrimaryEmployee.FirstName | string |
従業員の名。 |
|
LastName
|
PrimaryEmployee.LastName | string |
従業員の姓。 |
|
電話番号
|
PrimaryEmployee.ContactInformation.PhoneNumber | string |
従業員の電話番号。 |
|
HomePhoneNumber
|
PrimaryEmployee.ContactInformation.HomePhoneNumber | string |
従業員の自宅電話番号。 |
|
CellPhoneNumber
|
PrimaryEmployee.ContactInformation.CellPhoneNumber | string |
従業員の携帯電話番号。 |
|
ボイスメール
|
PrimaryEmployee.ContactInformation.Voicemail | string |
従業員のボイスメール。 |
|
FaxNumber
|
PrimaryEmployee.ContactInformation.FaxNumber | string |
従業員の FAX 番号。 |
|
メールアドレス
|
PrimaryEmployee.ContactInformation.EmailAddress | string |
従業員の電子メール アドレス。 |
|
PreferredCommunicationMethod
|
PrimaryEmployee.ContactInformation.PreferredCommunicationMethod | string |
従業員はコミュニケーション方法を優先しました。 |
|
Website
|
PrimaryEmployee.ContactInformation.Website | string |
従業員の Web リンク。 |
|
SecondaryEmployees
|
SecondaryEmployees | array of object |
セカンダリ 従業員に関する情報。 |
|
UserID
|
SecondaryEmployees.UserID | integer |
ユーザー ID 番号。 |
|
名前
|
SecondaryEmployees.Name | string |
セカンダリ 従業員の完全な名前。 |
|
ファーストネーム
|
SecondaryEmployees.FirstName | string |
セカンダリ 従業員の名。 |
|
LastName
|
SecondaryEmployees.LastName | string |
セカンダリ 従業員の姓。 |
|
電話番号
|
SecondaryEmployees.ContactInformation.PhoneNumber | string |
セカンダリ 従業員の電話番号。 |
|
HomePhoneNumber
|
SecondaryEmployees.ContactInformation.HomePhoneNumber | string |
セカンダリ 従業員の自宅の電話番号。 |
|
CellPhoneNumber
|
SecondaryEmployees.ContactInformation.CellPhoneNumber | string |
セカンダリ 従業員の携帯電話番号。 |
|
ボイスメール
|
SecondaryEmployees.ContactInformation.Voicemail | string |
セカンダリ従業員のボイスメール。 |
|
FaxNumber
|
SecondaryEmployees.ContactInformation.FaxNumber | string |
セカンダリ 従業員の FAX 番号。 |
|
メールアドレス
|
SecondaryEmployees.ContactInformation.EmailAddress | string |
セカンダリ 従業員の電子メール アドレス。 |
|
PreferredCommunicationMethod
|
SecondaryEmployees.ContactInformation.PreferredCommunicationMethod | string |
2 次従業員は、コミュニケーション方法を優先しました。 |
|
Website
|
SecondaryEmployees.ContactInformation.Website | string |
セカンダリ 従業員の Web リンク。 |
|
ReferenceNumber
|
ReferenceNumber | string |
参照番号。 |
|
RemoteFileNumber
|
RemoteFileNumber | string |
リモート ファイル番号。 |
|
PartnerTypeID
|
PartnerTypeID | integer |
パートナーの種類の ID 番号。 |
|
パートナーID
|
PartnerID | integer |
パートナー ID 番号。 |
|
PartnerTypeID
|
PartnerType.PartnerTypeID | integer |
パートナーの種類の ID 番号。 |
|
PartnerTypeName
|
PartnerType.PartnerTypeName | string |
パートナーの種類名。 |
|
OfficeID
|
OfficeID | integer |
オフィス ID 番号。 |
|
PartnerName
|
PartnerName | string |
パートナー名。 |
|
Address1
|
MailingAddress.Address1 | string |
番地と名前。 |
|
Address2
|
MailingAddress.Address2 | string |
詳細な住所情報。 |
|
市区町村
|
MailingAddress.City | string |
市区町村名。 |
|
State
|
MailingAddress.State | string |
2 文字の状態の省略形。 |
|
ZIPファイル
|
MailingAddress.Zip | string |
郵便番号。 |
|
電話番号
|
ContactInformation.PhoneNumber | string |
パートナーの電話番号。 |
|
HomePhoneNumber
|
ContactInformation.HomePhoneNumber | string |
パートナーの自宅の電話番号。 |
|
CellPhoneNumber
|
ContactInformation.CellPhoneNumber | string |
パートナーの携帯電話番号。 |
|
ボイスメール
|
ContactInformation.Voicemail | string |
パートナーボイスメール番号。 |
|
FaxNumber
|
ContactInformation.FaxNumber | string |
パートナー FAX 番号。 |
|
メールアドレス
|
ContactInformation.EmailAddress | string |
パートナーのメール アドレス。 |
|
PreferredCommunicationMethod
|
ContactInformation.PreferredCommunicationMethod | string |
パートナーはコミュニケーションの方法を優先しました。 |
|
Website
|
ContactInformation.Website | string |
パートナー Web サイトの URL。 |
特定のファイルのメモを取得する
指定したファイルのメモの一覧を取得します。
パラメーター
| 名前 | キー | 必須 | 型 | 説明 |
|---|---|---|---|---|
|
ファイル ID
|
FileID | True | string |
ファイル識別番号。 |
戻り値
| 名前 | パス | 型 | 説明 |
|---|---|---|---|
|
注記
|
Notes | array of object |
ファイル上のメモの一覧。 |
|
NoteID
|
Notes.NoteID | integer |
メモの識別番号。 |
|
サブジェクト
|
Notes.Subject | string |
ノートの件名。 |
|
Body
|
Notes.Body | string |
メモ本文。 |
|
UserID
|
Notes.CreatedBy.UserID | integer |
ユーザー ID 番号。 |
|
名前
|
Notes.CreatedBy.Name | string |
ユーザーのフル ネーム。 |
|
ファーストネーム
|
Notes.CreatedBy.FirstName | string |
ユーザーの名。 |
|
LastName
|
Notes.CreatedBy.LastName | string |
ユーザーの姓。 |
|
電話番号
|
Notes.CreatedBy.ContactInformation.PhoneNumber | string |
ユーザーの電話番号。 |
|
メールアドレス
|
Notes.CreatedBy.ContactInformation.EmailAddress | string |
ユーザーのメール アドレス。 |
|
CreatedDate
|
Notes.CreatedDate | string |
メモが作成された日付。 |
|
FileID
|
Notes.FileID | integer |
ファイル識別番号。 |
|
早める
|
Notes.Expedite | boolean |
メモが優先されたかどうか。 |
特定のファイルのユーザー設定フィールドを取得する
指定したファイルのユーザー設定フィールドを取得します。
パラメーター
| 名前 | キー | 必須 | 型 | 説明 |
|---|---|---|---|---|
|
ファイル ID
|
FileID | True | string |
ファイル識別番号。 |
戻り値
| 名前 | パス | 型 | 説明 |
|---|---|---|---|
|
CustomFields
|
CustomFields | array of object |
ファイルのユーザー設定フィールドの一覧。 |
|
名前
|
CustomFields.Name | string |
ユーザー設定フィールドの名前。 |
|
価値
|
CustomFields.Value | string |
ユーザー設定フィールドの値。 |
|
CustomFieldListCount
|
CustomFieldListCount | integer |
ファイルのユーザー設定フィールドの数。 |
特定のファイルのユーザー設定フィールドを追加または更新する
指定したファイルのユーザー設定フィールドを追加または更新します。
パラメーター
| 名前 | キー | 必須 | 型 | 説明 |
|---|---|---|---|---|
|
ファイル ID
|
FileID | True | string |
ファイル識別番号。 |
|
名前
|
Name | string |
ユーザー設定フィールドの名前。 |
|
|
価値
|
Value | string |
ユーザー設定フィールドの値。 |
戻り値
- response
- object
現在のユーザー情報を取得する
現在接続されているユーザーに関する情報を取得します。
戻り値
| 名前 | パス | 型 | 説明 |
|---|---|---|---|
|
Title
|
Title | string |
ユーザーのタイトル。 |
|
PasswordExpirationDate
|
PasswordExpirationDate | string |
パスワードの有効期限が切れる日付。 |
|
UserID
|
UserID | integer |
ユーザー ID 番号。 |
|
名前
|
Name | string |
ユーザーの名前です。 |
|
ファーストネーム
|
FirstName | string |
ユーザーの名。 |
|
LastName
|
LastName | string |
ユーザーの姓。 |
|
CellPhoneNumber
|
ContactInformation.CellPhoneNumber | string |
ユーザーの携帯電話番号。 |
|
メールアドレス
|
ContactInformation.EmailAddress | string |
ユーザーの電子メール アドレス。 |
|
PreferredCommunicationMethod
|
ContactInformation.PreferredCommunicationMethod | string |
ユーザーが優先する通信方法。 |
|
電話番号
|
ContactInformation.PhoneNumber | string |
ユーザーの電話番号。 |
|
FaxNumber
|
ContactInformation.FaxNumber | string |
ユーザーの Fax 番号。 |
|
Website
|
ContactInformation.Website | string |
ユーザーの Web サイト。 |
見積と注文の配置のためにトランザクションと製品の種類を取得する
手数料の見積もりと注文のトランザクションの種類と製品の種類を取得します。
パラメーター
| 名前 | キー | 必須 | 型 | 説明 |
|---|---|---|---|---|
|
State
|
State | string |
推定プロパティの場所の状態。 |
|
|
郡
|
County | string |
推定プロパティの場所の郡。 |
戻り値
| 名前 | パス | 型 | 説明 |
|---|---|---|---|
|
|
array of object | ||
|
TransactionType
|
TransactionType | string |
トランザクションの種類。 |
|
TransactionTypeID
|
TransactionTypeID | integer |
トランザクションの種類の識別番号。 |
|
ProductType
|
ProductType | string |
製品の種類。 |
|
ProductTypeID
|
ProductTypeID | integer |
製品の種類の識別番号。 |
|
AncillaryProducts
|
AncillaryProducts | array of object |
補助製品。 |
|
名前
|
AncillaryProducts.Name | string |
補助製品の名前。 |
|
ID
|
AncillaryProducts.ID | integer |
製品の識別番号。 |
|
オプション
|
AncillaryProducts.Options | array of object |
オプション。 |
|
ID
|
AncillaryProducts.Options.ID | integer |
オプションの識別番号。 |
|
名前
|
AncillaryProducts.Options.Name | string |
オプションの名前。 |
|
AddOnProducts
|
AddOnProducts | array of object |
製品に追加されます。 |
|
TransactionType
|
AddOnProducts.TransactionType | string |
トランザクションの種類。 |
|
TransactionTypeID
|
AddOnProducts.TransactionTypeID | integer |
トランザクションの種類の識別番号。 |
|
ProductType
|
AddOnProducts.ProductType | string |
製品の種類。 |
|
ProductTypeID
|
AddOnProducts.ProductTypeID | integer |
製品の種類の識別番号。 |
定義
オブジェクト
これは型 'object' です。