InfoQuery
InfoQuery を使用すると、ローコード ソリューションで Resware データを活用して、ビジネスを自動化できます。 ファイルやドキュメント、パートナーなどを表示、作成、削除、更新できます。
このコネクタは、次の製品および地域で利用可能です:
| Service | クラス | 地域 |
|---|---|---|
| Logic Apps | 標準 | 以下を除くすべての Logic Apps 地域 : - Azure 政府の地域 - Azure 中国の地域 - 国防総省 (DoD) |
| Power Automate | プレミアム | 以下を除くすべての Power Automate 地域 : - 米国政府 (GCC) - 米国政府 (GCC High) - 21Vianet が運用する中国のクラウド - 国防総省 (DoD) |
| Power Apps | プレミアム | 以下を除くすべての Power Apps 地域 : - 米国政府 (GCC) - 米国政府 (GCC High) - 21 Vianet が運用する中国のクラウド - 米国国防総省 (DoD) |
| お問い合わせ先 | |
|---|---|
| 件名 | InfoQuery サポート |
| [URL] | https://infoquery.pro/support/ |
| メール | support@infoquery.pro |
| Connector Metadata | |
|---|---|
| 発行者 | InfoQuery LLC |
| Web サイト | https://infoquery.pro/ |
| プライバシー ポリシー | https://infoquery.pro/privacy/ |
| カテゴリー | コンテンツとファイル、データ |
InfoQuery Title Explorer を使用すると、Resware システムへの変更を自動化できます。 ファイル、アクション、メモ、ドキュメントなどを追加、削除、または編集することができます。
前提条件
- API キーが必要なので、https://connector.infoquery.pro/ でサインアップする必要があります
- また、Resware アカウントも必要です。 接続を形成するには、ユーザー名、パスワード、およびポータル URL が必要です。
資格情報の入手方法
- https://connector.infoquery.pro/signup へ移動し、アカウントを作成します。 ここから、選択したサブスクリプションを選択でき、後に API キーが提供されます。
- サブスクリプションおよび価格の詳細については、https://connector.infoquery.pro/products をご覧ください。
- Resware アカウントの詳細は、Resware 管理者によって提供されます。
コネクタの使用を開始する
- Power Automate https://powerautomate.microsoft.com に移動します。
- 新規フローを作成するか、既存のフローを編集します。
- フローに新しいステップを追加し、InfoQuery Title Explorer を検索して、使用可能なすべてのアクションを表示します。
- アクションを選択したら、新しい接続を作成する必要があります。
- 接続名、API キー、Resware ユーザー名、パスワード、およびポータル URL を入力します。 ポータル URL の形式は、https://portal.infoquery.com/API のフォーマットにあります。
- サポートが必要な場合は、support@infoquery.pro にお問い合わせいただくか、https://infoquery.pro/support/ をご覧ください。
既知の問題と制限事項
Resware を利用する各企業は、特定のニーズに合わせてカスタマイズすることができます。 Resware の設定によっては、コネクタが正しく機能するために、特定のアクションで特定の情報を提供する必要がある場合があります。 Resware システムのナレッジが必要になります。
一般的なエラーと解決策
アクションでは、200 の応答を返すことがありますが、期待される情報は返されません。 これは、特定の Resware 設定に必要な情報が提供されていないことが原因である可能性があります。 ご提供いただいた情報は Resware に正常に送信され、200 の応答が返されましたが、アクションが期待どおりに行われなかった可能性があります。 Resware 管理者またはポータルは、アクションを完了するために必要な情報を提供できます。
よくあるご質問
Resware ポータルの URL はどこにありますか?
Resware 管理者によってポータル URL が提供されます。
API キーを受ける方法は?
https://connector.infoquery.pro/signup へ移動し、アカウントを作成します。 ここから、選択したサブスクリプションを選択でき、後に API キーが提供されます。
接続を作成する
このコネクタは、次の認証タイプをサポートしています:
| 既定 | 接続を作成するためのパラメーター。 | すべての地域 | 共有不可 |
既定
適用できるもの: すべての領域
接続を作成するためのパラメーター。
これは共有可能な接続ではありません。 パワー アプリが別のユーザーと共有されている場合、別のユーザーは新しい接続を明示的に作成するように求められます。
| 件名 | タイプ | 説明設定 | Required |
|---|---|---|---|
| API Key | securestring | この API の API キー | True |
| ResWare ユーザー名 | string | ResWare のユーザー名 | True |
| ResWare のパスワード | securestring | ResWare のパスワード | True |
| ResWare ポータル URL | string | ResWare のポータル URL | True |
調整制限
| 名前 | 呼び出し | 更新期間 |
|---|---|---|
| 接続ごとの API 呼び出し | 100 | 60 秒 |
アクション
| Web URL のドキュメントを指定ファイルにアップロード |
指定されたファイルで Web URL ドキュメントを読み込みます。 |
| アクションをファイルに追加 |
指定されたファイルにアクションを追加します。 |
| ドキュメントを取得 |
指定した ID でドキュメントの情報を取得します。 |
| パートナーを特定のファイルに追加 |
指定されたファイルにパートナーを追加します。 |
| パートナー企業に新しいパートナー従業員を追加 |
パートナー企業に新しいパートナー従業員を追加します。 |
| パートナー従業員の更新 |
パートナー従業員の情報を更新します。 |
| パートナー情報を取得 |
指定した ID でパートナーの情報を取得します。 |
| ファイルのアクションを更新 |
特定のファイルのアクションを更新します。 アクション グループ ID を更新し、コーディネーター タイプ ID、パートナー タイプ ID、期日、期日ロック、および完了日ロックを開始/完了できます。 API 呼び出しを使用して、アクションを開始済みまたは完了済みとしてマークすることはできません。 |
| メモの取得 |
指定された ID でメモを取得します。 |
| メモをファイルに追加する |
新しいメモを指定されたファイルに追加します。 |
| 以前の注文をキャンセルする |
以前の注文をキャンセルします。 |
| 以前の注文を削除する |
以前の注文をキャンセルします。 |
| 成約手数料の見積もり |
成約手数料を見積もります。 |
| 成約料の見積もり領収書の PDS を受け取る |
成約手数料の見積もり領収書を PDF 形式で取得します。 |
| 成約料の見積もり領収書を受け取る |
成約料の見積もり領収書を受け取ります。 |
| 指定されたファイルのパートナー情報を更新 |
指定したファイルのパートナー情報を更新します。 |
| 指定された検索条件からファイルを取得 |
指定された検索条件に基づいて、ファイルとその情報のリストを取得します。 |
| 新しいファイルを作成 |
新しいファイルを作成します。 |
| 特定のドキュメントのカスタム フィールドを取得 |
特定のドキュメントのカスタム フィールドを取得します。 |
| 特定のドキュメントのカスタム フィールドを追加または更新する |
指定されたファイルで指定されたドキュメントのカスタム フィールドを追加または更新します。 |
| 特定のファイルでカスタム フィールドを追加または更新する |
指定されたファイルのカスタム フィールドを追加または更新します。 |
| 特定のファイルに新しいドキュメントを作成 |
特定のファイルに新しいドキュメントを作成します。 |
| 特定のファイルのカスタム フィールド取得 |
指定されたファイルのカスタム フィールドを取得します。 |
| 特定のファイルのパートナーを削除 |
指定されたファイルからパートナーを削除します。 |
| 特定ファイルのアクションを取得 |
指定されたファイルに対するすべてのアクションを取得します。 |
| 特定ファイルのドキュメントを取得 |
指定されたファイルのドキュメントに関するすべての情報を取得します。 |
| 特定ファイルのパーティーを取得 |
指定されたファイルのパーティーの一覧と情報を取得します。 |
| 特定ファイルのパートナーを取得 |
指定されたファイルのパートナーの一覧と情報を取得します。 |
| 特定ファイルのメモを取得 |
指定したファイルのメモの一覧を取得します。 |
| 現在のユーザー情報を取得する |
現在接続しているユーザーの情報を取得します。 |
| 見積もりと発注のためのトランザクションと製品タイプを取得 |
料金の見積もりと発注のためのトランザクションと製品タイプを取得します。 |
Web URL のドキュメントを指定ファイルにアップロード
指定されたファイルで Web URL ドキュメントを読み込みます。
パラメーター
| 名前 | キー | 必須 | 型 | 説明 |
|---|---|---|---|---|
|
ファイル ID
|
FileID | True | string |
ファイル ID 番号。 |
|
DocumentName
|
DocumentName | string |
ドキュメント名。 |
|
|
DocumentTypeID
|
DocumentTypeID | integer |
ドキュメント タイプの識別番号。 |
|
|
説明設定
|
Description | string |
ドキュメントの説明。 |
|
|
InternalOnly
|
InternalOnly | boolean |
ドキュメントが内部のみなのかどうか。 |
|
|
WebURL
|
WebURL | string |
ドキュメントの Web URL。 |
戻り値
| 名前 | パス | 型 | 説明 |
|---|---|---|---|
|
DocumentID
|
Document.DocumentID | integer |
ドキュメントの識別番号。 |
アクションをファイルに追加
指定されたファイルにアクションを追加します。
パラメーター
| 名前 | キー | 必須 | 型 | 説明 |
|---|---|---|---|---|
|
ファイル ID
|
FileID | True | string |
ファイル ID 番号。 |
|
ActionTypeID
|
ActionTypeID | integer |
アクション タイプの識別番号。 |
|
|
ActionGroupID
|
ActionGroupID | integer |
アクション グループの識別番号。 |
|
|
CoordinatorTypeID
|
CoordinatorTypeID | integer |
コーディネーター タイプの識別番号。 |
|
|
DueDate
|
DueDate | string |
アクションの期限。 |
|
|
PartnerTypeID
|
PartnerTypeID | integer |
パートナー タイプの識別番号。 |
|
|
DueDate
|
DueDate | string |
アクションの期限。 |
戻り値
| 名前 | パス | 型 | 説明 |
|---|---|---|---|
|
FileActionID
|
FileActionID | integer |
ファイル アクションの識別番号。 |
ドキュメントを取得
指定した ID でドキュメントの情報を取得します。
パラメーター
| 名前 | キー | 必須 | 型 | 説明 |
|---|---|---|---|---|
|
Document ID
|
DocumentID | True | string |
ドキュメントの識別番号。 |
戻り値
| 名前 | パス | 型 | 説明 |
|---|---|---|---|
|
DocumentID
|
DocumentID | integer |
ドキュメントの識別番号。 |
|
DocumentName
|
DocumentName | string |
ドキュメント名。 |
|
DocumentTypeID
|
DocumentType.DocumentTypeID | integer |
ドキュメント タイプ名。 |
|
件名
|
DocumentType.Name | string |
ドキュメント タイプ名。 |
|
説明設定
|
Description | string |
ドキュメントの説明。 |
|
InternalOnly
|
InternalOnly | boolean |
ドキュメントが内部のみなのかどうか。 |
|
Approved
|
Approved | boolean |
ドキュメントが承認されたかどうか。 |
|
UserID
|
CreateUser.UserID | integer |
ユーザーの識別番号。 |
|
CreateDate
|
CreateDate | string |
ドキュメントが作成された日付。 |
パートナーを特定のファイルに追加
指定されたファイルにパートナーを追加します。
パラメーター
| 名前 | キー | 必須 | 型 | 説明 |
|---|---|---|---|---|
|
ファイル ID
|
FileID | True | string |
ファイル ID 番号。 |
|
UserID
|
UserID | integer |
ユーザーの識別番号。 |
|
|
UserID
|
UserID | integer |
ユーザーの識別番号。 |
|
|
PartnerTypeID
|
PartnerTypeID | integer |
パートナー タイプの識別番号。 |
|
|
PartnerID
|
PartnerID | integer |
パートナー タイプの識別番号。 |
|
|
PartnerTypeID
|
PartnerTypeID | integer |
パートナー タイプの識別番号。 |
戻り値
- 返答
- object
パートナー企業に新しいパートナー従業員を追加
パートナー企業に新しいパートナー従業員を追加します。
パラメーター
| 名前 | キー | 必須 | 型 | 説明 |
|---|---|---|---|---|
|
パートナー会社 ID
|
PartnerCompanyID | True | string |
パートナー会社の識別番号。 |
|
Password
|
Password | string |
新しい従業員のパスワード。 |
|
|
PasswordExpirationDate
|
PasswordExpirationDate | string |
パスワードが切れる日付です。 |
|
|
有効化
|
Enabled | boolean |
新しい従業員を使用できるようにするかどうか。 |
|
|
WebsiteAccess
|
WebsiteAccess | boolean |
新入社員が Web サイトにアクセスできるかどうか。 |
|
|
件名
|
Name | string |
新しい従業員の氏名。 |
|
|
FirstName
|
FirstName | string |
新しい従業員の氏名。 |
|
|
LastName
|
LastName | string |
新しい従業員の姓。 |
|
|
EmailAddress
|
EmailAddress | string |
新しい従業員のメール アドレス。 |
戻り値
| 名前 | パス | 型 | 説明 |
|---|---|---|---|
|
PartnerCompanyID
|
Employee.PartnerCompanyID | integer |
パートナー会社の識別番号。 |
|
有効化
|
Employee.Enabled | boolean |
新しい従業員を使用できているかどうか。 |
|
WebsiteAccess
|
Employee.WebsiteAccess | boolean |
従業員が Web サイトにアクセスできるかどうか。 |
|
UserID
|
Employee.UserID | integer |
新しい従業員の識別番号。 |
|
件名
|
Employee.Name | string |
従業員の氏名。 |
|
FirstName
|
Employee.FirstName | string |
従業員の名。 |
|
LastName
|
Employee.LastName | string |
従業員の姓。 |
|
EmailAddress
|
Employee.ContactInformation.EmailAddress | string |
従業員のメール アドレス。 |
パートナー従業員の更新
パートナー従業員の情報を更新します。
パラメーター
| 名前 | キー | 必須 | 型 | 説明 |
|---|---|---|---|---|
|
User ID
|
UserID | True | string |
ユーザー識別番号。 |
|
パートナー会社 ID
|
PartnerCompanyID | True | string |
パートナー会社の識別番号。 |
|
Password
|
Password | string |
従業員のパスワード。 |
|
|
PasswordExpirationDate
|
PasswordExpirationDate | string |
パスワードが切れる日付です。 |
|
|
RoleID
|
RoleID | integer |
役割識別番号。 |
|
|
件名
|
Name | string |
ロールの名前です。 |
|
|
有効化
|
Enabled | boolean |
従業員を使用できているかどうか。 |
|
|
WebsiteAccess
|
WebsiteAccess | boolean |
従業員が Web サイトにアクセスできるかどうか。 |
|
|
件名
|
Name | string |
従業員の氏名。 |
|
|
FirstName
|
FirstName | string |
従業員の名。 |
|
|
LastName
|
LastName | string |
従業員の姓。 |
|
|
EmailAddress
|
EmailAddress | string |
従業員のメール アドレス。 |
戻り値
| 名前 | パス | 型 | 説明 |
|---|---|---|---|
|
PartnerCompanyID
|
Employee.PartnerCompanyID | integer |
パートナー会社の識別番号。 |
|
Roles
|
Employee.Roles | array of object |
従業員の役割。 |
|
RoleID
|
Employee.Roles.RoleID | integer |
役割識別番号。 |
|
件名
|
Employee.Roles.Name | string |
ロールの名前です。 |
|
有効化
|
Employee.Enabled | boolean |
従業員を使用できているかどうか。 |
|
WebsiteAccess
|
Employee.WebsiteAccess | boolean |
従業員が Web サイトにアクセスできるかどうか。 |
|
UserID
|
Employee.UserID | integer |
ユーザーの識別番号。 |
|
件名
|
Employee.Name | string |
従業員の氏名。 |
|
FirstName
|
Employee.FirstName | string |
従業員の名。 |
|
LastName
|
Employee.LastName | string |
従業員の姓。 |
|
EmailAddress
|
Employee.ContactInformation.EmailAddress | string |
従業員のメール アドレス。 |
パートナー情報を取得
指定した ID でパートナーの情報を取得します。
パラメーター
| 名前 | キー | 必須 | 型 | 説明 |
|---|---|---|---|---|
|
パートナー会社 ID
|
PartnerCompanyID | True | string |
パートナー会社の識別番号。 |
戻り値
| 名前 | パス | 型 | 説明 |
|---|---|---|---|
|
PartnerCompanyID
|
PartnerCompanyID | integer |
パートナー会社の識別番号。 |
|
PartnerTypes
|
PartnerTypes | array of object |
パートナー タイプに関する情報。 |
|
PartnerTypeID
|
PartnerTypes.PartnerTypeID | integer |
パートナー タイプの識別番号。 |
|
PartnerTypeName
|
PartnerTypes.PartnerTypeName | string |
パートナー タイプ名。 |
|
OfficeID
|
OfficeID | integer |
事務所 ID 番号。 |
|
PartnerName
|
PartnerName | string |
パートナー名。 |
|
CompanyAbbreviation
|
CompanyAbbreviation | string |
会社の略語。 |
|
ProperCompanyName
|
ProperCompanyName | string |
会社名。 |
|
住所1
|
MailingAddress.Address1 | string |
通りの番号と名前。 |
|
住所2
|
MailingAddress.Address2 | string |
さらなる住所情報。 |
|
都市
|
MailingAddress.City | string |
市区町村の名前。 |
|
状態
|
MailingAddress.State | string |
2 文字の州の省略形。 |
|
郵便番号
|
MailingAddress.Zip | string |
ZIP コードです。 |
|
PhoneNumber
|
ContactInformation.PhoneNumber | string |
パートナーの電話番号。 |
|
HomePhoneNumber
|
ContactInformation.HomePhoneNumber | string |
パートナーの電話番号。 |
|
CellPhoneNumber
|
ContactInformation.CellPhoneNumber | string |
パートナーの携帯番号。 |
|
ボイスメール
|
ContactInformation.Voicemail | string |
パートナーのバイスメール番号。 |
|
FaxNumber
|
ContactInformation.FaxNumber | string |
パートナー FAX 番号。 |
|
EmailAddress
|
ContactInformation.EmailAddress | string |
パートナーのメール アドレス。 |
|
PreferredCommunicationMethod
|
ContactInformation.PreferredCommunicationMethod | string |
パートナーの好ましいコミュケーション方法。 |
|
Web サイト
|
ContactInformation.Website | string |
パートナーの Web サイトの URL。 |
|
ID
|
CompanyInformation.ParentCompany.ID | integer |
ID 番号。 |
|
件名
|
CompanyInformation.ParentCompany.Name | string |
パートナーの会社名。 |
|
ID
|
CompanyInformation.PartnerEntity.ID | integer |
ID 番号。 |
|
名称
|
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 |
これが支払いに使用されるかどうか。 |
|
住所1
|
CourierAddress.Address1 | string |
通りの番号と名前。 |
|
住所2
|
CourierAddress.Address2 | string |
さらなる住所情報。 |
|
都市
|
CourierAddress.City | string |
市区町村の名前。 |
|
状態
|
CourierAddress.State | string |
2 文字の州の省略形。 |
|
郵便番号
|
CourierAddress.Zip | string |
ZIP コードです。 |
ファイルのアクションを更新
特定のファイルのアクションを更新します。 アクション グループ ID を更新し、コーディネーター タイプ ID、パートナー タイプ ID、期日、期日ロック、および完了日ロックを開始/完了できます。 API 呼び出しを使用して、アクションを開始済みまたは完了済みとしてマークすることはできません。
パラメーター
| 名前 | キー | 必須 | 型 | 説明 |
|---|---|---|---|---|
|
ファイル ID
|
FileID | True | string |
ファイル ID 番号。 |
|
ファイル アクション ID
|
FileActionID | True | string |
アクションの識別番号。 |
|
CoordinatorTypeID
|
CoordinatorTypeID | integer |
コーディネーター タイプの識別番号。 |
|
|
DueDate
|
DueDate | string |
アクションの期限。 |
|
|
DoneDateLocked
|
DoneDateLocked | boolean |
完了日がロック済みかどうか。 |
|
|
CoordinatorTypeID
|
CoordinatorTypeID | integer |
コーディネーター タイプの識別番号。 |
|
|
DueDate
|
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 |
ユーザーの識別番号。 |
|
CreatedDate
|
CreatedDate | string |
メモを作成した日付。 |
|
FileID
|
FileID | integer |
ファイルの識別番号。 |
メモをファイルに追加する
新しいメモを指定されたファイルに追加します。
パラメーター
| 名前 | キー | 必須 | 型 | 説明 |
|---|---|---|---|---|
|
ファイル ID
|
FileID | True | string |
ファイル ID 番号。 |
|
サブジェクト
|
Subject | string |
メモの件名。 |
|
|
Body
|
Body | string |
メモの本文。 |
戻り値
| 名前 | パス | 型 | 説明 |
|---|---|---|---|
|
NoteID
|
note.NoteID | integer |
メモの識別番号。 |
以前の注文をキャンセルする
以前の注文をキャンセルします。
パラメーター
| 名前 | キー | 必須 | 型 | 説明 |
|---|---|---|---|---|
|
ファイル ID
|
FileID | True | string |
ファイル ID 番号。 |
|
FileID
|
FileID | integer |
ファイルの識別番号。 |
戻り値
- 返答
- object
以前の注文を削除する
以前の注文をキャンセルします。
パラメーター
| 名前 | キー | 必須 | 型 | 説明 |
|---|---|---|---|---|
|
ファイル ID
|
FileID | True | string |
ファイル ID 番号。 |
|
FileID
|
FileID | integer |
ファイルの識別番号。 |
戻り値
- 返答
- object
成約手数料の見積もり
成約手数料を見積もります。
パラメーター
| 名前 | キー | 必須 | 型 | 説明 |
|---|---|---|---|---|
|
TransactionTypeID
|
TransactionTypeID | integer |
トランザクション タイプの識別番号。 |
|
|
ProductTypeID
|
ProductTypeID | integer |
製品タイプの識別番号。 |
|
|
SettlementStatementVersion
|
SettlementStatementVersion | string |
決済のステートメント バージョン。 |
|
|
SalesPrice
|
SalesPrice | integer |
販売価格。 |
|
|
LienPosition
|
LienPosition | integer |
先取特権。 |
|
|
LoanAmount
|
LoanAmount | integer |
ローン量。 |
|
|
LoanType
|
LoanType | string |
ローン タイプ。 |
|
|
IsPrimary
|
IsPrimary | boolean |
これがプライマリ プロパティであるかどうか。 |
|
|
StreetNumber
|
StreetNumber | string |
通りの番号。 |
|
|
StreetName
|
StreetName | string |
通りの番号。 |
|
|
都市
|
City | string |
市区町村の名前。 |
|
|
状態
|
State | string |
2 文字の州の省略形。 |
|
|
国
|
County | string |
国名。 |
|
|
郵便番号
|
Zip | string |
ZIP コードです。 |
|
|
PartnerTypeID
|
PartnerTypeID | integer |
パートナー タイプの識別番号。 |
|
|
PartnerID
|
PartnerID | integer |
パートナー タイプの識別番号。 |
|
|
PartnerTypeID
|
PartnerTypeID | integer |
パートナー タイプの識別番号。 |
|
|
件名
|
Name | string |
承認名。 |
戻り値
| 名前 | パス | 型 | 説明 |
|---|---|---|---|
|
ClosingFeeEstimateID
|
ClosingFeeEstimate.ClosingFeeEstimateID | integer |
成約料金の見積もり識別番号。 |
|
HUDFees
|
ClosingFeeEstimate.HUDFees | array of object |
HUD 料金。 |
|
Amount
|
ClosingFeeEstimate.HUDFees.Amount | integer |
HUD 料金の額。 |
|
説明設定
|
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 |
パートナー タイプの識別番号。 |
|
PartnerTypeName
|
ClosingFeeEstimate.HUDFees.OtherPOCPartnerType.PartnerTypeName | string |
パートナー タイプ名。 |
|
GFE
|
ClosingFeeEstimate.GFE | array of object |
誠実な見積もり。 |
|
説明設定
|
ClosingFeeEstimate.GFE.Description | string |
見積もりは何のためですか。 |
|
Amount
|
ClosingFeeEstimate.GFE.Amount | integer |
見積もり金額。 |
|
LendersPremium
|
ClosingFeeEstimate.Premiums.LendersPremium | integer |
貸し手のプレミアム。 |
|
FullLendersPremium
|
ClosingFeeEstimate.Premiums.FullLendersPremium | integer |
全額貸し手のプレミアム。 |
|
Timestamp
|
ClosingFeeEstimate.Timestamp | string |
タイムスタンプ。 |
成約料の見積もり領収書の PDS を受け取る
成約手数料の見積もり領収書を PDF 形式で取得します。
パラメーター
| 名前 | キー | 必須 | 型 | 説明 |
|---|---|---|---|---|
|
成約料金 ID
|
ClosingFeeID | True | string |
成約料金の識別番号。 |
戻り値
- 返答
- object
成約料の見積もり領収書を受け取る
成約料の見積もり領収書を受け取ります。
パラメーター
| 名前 | キー | 必須 | 型 | 説明 |
|---|---|---|---|---|
|
成約料金 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 |
先取特権。 |
|
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 |
市区町村の名前。 |
|
状態
|
Request.Properties.State | string |
2 文字の州の省略形。 |
|
国
|
Request.Properties.County | string |
国名。 |
|
郵便番号
|
Request.Properties.Zip | string |
ZIP コードです。 |
|
FilePartners
|
Request.FilePartners | array of object |
ファイル上のパートナー。 |
|
PartnerTypeID
|
Request.FilePartners.PartnerTypeID | integer |
パートナー タイプの識別番号。 |
|
PartnerID
|
Request.FilePartners.PartnerID | integer |
パートナー タイプの識別番号。 |
|
PartnerTypeID
|
Request.FilePartners.PartnerType.PartnerTypeID | integer |
パートナー タイプの識別番号。 |
|
承認
|
Request.Endorsements | array of object |
承認。 |
|
件名
|
Request.Endorsements.Name | string |
承認名。 |
|
ClosingFeeEstimateID
|
Response.ClosingFeeEstimateID | integer |
成約料金の見積もり識別番号。 |
|
HUDFees
|
Response.HUDFees | array of object |
HUD 料金。 |
|
Amount
|
Response.HUDFees.Amount | integer |
HUD 料金の額。 |
|
説明設定
|
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 |
パートナー タイプの識別番号。 |
|
PartnerTypeName
|
Response.HUDFees.OtherPOCPartnerType.PartnerTypeName | string |
パートナー タイプ名。 |
|
GFE
|
Response.GFE | array of object |
誠実な見積もり。 |
|
説明設定
|
Response.GFE.Description | string |
見積もりは何のためですか。 |
|
Amount
|
Response.GFE.Amount | integer |
見積もり金額。 |
|
LendersPremium
|
Response.Premiums.LendersPremium | integer |
貸し手のプレミアム。 |
|
FullLendersPremium
|
Response.Premiums.FullLendersPremium | integer |
全額貸し手のプレミアム。 |
|
Timestamp
|
Response.Timestamp | string |
タイムスタンプ。 |
指定されたファイルのパートナー情報を更新
指定したファイルのパートナー情報を更新します。
パラメーター
| 名前 | キー | 必須 | 型 | 説明 |
|---|---|---|---|---|
|
ファイル ID
|
FileID | True | string |
ファイル ID 番号。 |
|
パートナー ID
|
PartnerID | True | string |
パートナー識別番号。 |
|
FileID
|
FileID | integer |
ファイルの識別番号。 |
|
|
UserID
|
UserID | integer |
ユーザーの識別番号。 |
|
|
件名
|
Name | string |
従業員の氏名。 |
|
|
FirstName
|
FirstName | string |
従業員の名。 |
|
|
LastName
|
LastName | string |
従業員の姓。 |
|
|
PhoneNumber
|
PhoneNumber | string |
従業員の電話番号。 |
|
|
HomePhoneNumber
|
HomePhoneNumber | string |
従業員の自宅電話番号。 |
|
|
CellPhoneNumber
|
CellPhoneNumber | string |
従業員の携帯番号。 |
|
|
ボイスメール
|
Voicemail | string |
従業員のボイスメール。 |
|
|
FaxNumber
|
FaxNumber | string |
従業員の FAX 番号。 |
|
|
EmailAddress
|
EmailAddress | string |
従業員のメール アドレス。 |
|
|
PreferredCommunicationMethod
|
PreferredCommunicationMethod | string |
従業員が好むコミュニケーション方法。 |
|
|
Web サイト
|
Website | string |
従業員の Web リンク。 |
|
|
UserID
|
UserID | integer |
ユーザーの識別番号。 |
|
|
件名
|
Name | string |
二次従業員の氏名。 |
|
|
FirstName
|
FirstName | string |
二次従業員の名前。 |
|
|
LastName
|
LastName | string |
二次従業員の姓。 |
|
|
PhoneNumber
|
PhoneNumber | string |
二次従業員の電話番号。 |
|
|
HomePhoneNumber
|
HomePhoneNumber | string |
二次従業員の自宅の電話番号。 |
|
|
CellPhoneNumber
|
CellPhoneNumber | string |
二次従業員の携帯番号。 |
|
|
ボイスメール
|
Voicemail | string |
二次従業員のボイスメール。 |
|
|
FaxNumber
|
FaxNumber | string |
二次従業員の Fax 番号。 |
|
|
EmailAddress
|
EmailAddress | string |
二次従業員のメール アドレス。 |
|
|
PreferredCommunicationMethod
|
PreferredCommunicationMethod | string |
二次従業員が好むコミュニケーション方法。 |
|
|
Web サイト
|
Website | string |
二次従業員の Web リンク。 |
|
|
ReferenceNumber
|
ReferenceNumber | string |
参照番号。 |
|
|
RemoteFileNumber
|
RemoteFileNumber | string |
リモートのファイル番号。 |
|
|
PartnerTypeID
|
PartnerTypeID | integer |
パートナー タイプの識別番号。 |
|
|
PartnerID
|
PartnerID | integer |
パートナー タイプの識別番号。 |
|
|
PartnerTypeID
|
PartnerTypeID | integer |
パートナー タイプの識別番号。 |
|
|
PartnerTypeName
|
PartnerTypeName | string |
パートナー タイプ名。 |
|
|
OfficeID
|
OfficeID | integer |
事務所 ID 番号。 |
|
|
PartnerName
|
PartnerName | string |
パートナー名。 |
|
|
住所1
|
Address1 | string |
通りの番号と名前。 |
|
|
住所2
|
Address2 | string |
さらなる住所情報。 |
|
|
都市
|
City | string |
市区町村の名前。 |
|
|
状態
|
State | string |
2 文字の州の省略形。 |
|
|
郵便番号
|
Zip | string |
ZIP コードです。 |
|
|
PhoneNumber
|
PhoneNumber | string |
パートナーの電話番号。 |
|
|
HomePhoneNumber
|
HomePhoneNumber | string |
パートナーの電話番号。 |
|
|
CellPhoneNumber
|
CellPhoneNumber | string |
パートナーの携帯番号。 |
|
|
ボイスメール
|
Voicemail | string |
パートナーのバイスメール番号。 |
|
|
FaxNumber
|
FaxNumber | string |
パートナー FAX 番号。 |
|
|
EmailAddress
|
EmailAddress | string |
パートナーのメール アドレス。 |
|
|
PreferredCommunicationMethod
|
PreferredCommunicationMethod | string |
パートナーの好ましいコミュケーション方法。 |
|
|
Web サイト
|
Website | string |
パートナーの Web サイトの URL。 |
戻り値
| 名前 | パス | 型 | 説明 |
|---|---|---|---|
|
FileID
|
FileID | integer |
ファイルの識別番号。 |
|
FileNumber
|
FileNumber | string |
ファイル番号 |
|
UserID
|
PrimaryEmployee.UserID | integer |
ユーザーの識別番号。 |
|
件名
|
PrimaryEmployee.Name | string |
従業員の氏名。 |
|
FirstName
|
PrimaryEmployee.FirstName | string |
従業員の名。 |
|
LastName
|
PrimaryEmployee.LastName | string |
従業員の姓。 |
|
PhoneNumber
|
PrimaryEmployee.ContactInformation.PhoneNumber | string |
従業員の電話番号。 |
|
HomePhoneNumber
|
PrimaryEmployee.ContactInformation.HomePhoneNumber | string |
従業員の自宅電話番号。 |
|
CellPhoneNumber
|
PrimaryEmployee.ContactInformation.CellPhoneNumber | string |
従業員の携帯番号。 |
|
ボイスメール
|
PrimaryEmployee.ContactInformation.Voicemail | string |
従業員のボイスメール。 |
|
FaxNumber
|
PrimaryEmployee.ContactInformation.FaxNumber | string |
従業員の FAX 番号。 |
|
EmailAddress
|
PrimaryEmployee.ContactInformation.EmailAddress | string |
従業員のメール アドレス。 |
|
PreferredCommunicationMethod
|
PrimaryEmployee.ContactInformation.PreferredCommunicationMethod | string |
従業員が好むコミュニケーション方法。 |
|
Web サイト
|
PrimaryEmployee.ContactInformation.Website | string |
従業員の Web リンク。 |
|
SecondaryEmployees
|
SecondaryEmployees | array of object |
二次従業員に関する情報。 |
|
UserID
|
SecondaryEmployees.UserID | integer |
ユーザーの識別番号。 |
|
件名
|
SecondaryEmployees.Name | string |
二次従業員の氏名。 |
|
FirstName
|
SecondaryEmployees.FirstName | string |
二次従業員の名前。 |
|
LastName
|
SecondaryEmployees.LastName | string |
二次従業員の姓。 |
|
PhoneNumber
|
SecondaryEmployees.ContactInformation.PhoneNumber | string |
二次従業員の電話番号。 |
|
HomePhoneNumber
|
SecondaryEmployees.ContactInformation.HomePhoneNumber | string |
二次従業員の自宅の電話番号。 |
|
CellPhoneNumber
|
SecondaryEmployees.ContactInformation.CellPhoneNumber | string |
二次従業員の携帯番号。 |
|
ボイスメール
|
SecondaryEmployees.ContactInformation.Voicemail | string |
二次従業員のボイスメール。 |
|
FaxNumber
|
SecondaryEmployees.ContactInformation.FaxNumber | string |
二次従業員の Fax 番号。 |
|
EmailAddress
|
SecondaryEmployees.ContactInformation.EmailAddress | string |
二次従業員のメール アドレス。 |
|
PreferredCommunicationMethod
|
SecondaryEmployees.ContactInformation.PreferredCommunicationMethod | string |
二次従業員が好むコミュニケーション方法。 |
|
Web サイト
|
SecondaryEmployees.ContactInformation.Website | string |
二次従業員の Web リンク。 |
|
ReferenceNumber
|
ReferenceNumber | string |
参照番号。 |
|
RemoteFileNumber
|
RemoteFileNumber | string |
リモートのファイル番号。 |
|
PartnerTypeID
|
PartnerTypeID | integer |
パートナー タイプの識別番号。 |
|
PartnerID
|
PartnerID | integer |
パートナー タイプの識別番号。 |
|
PartnerTypeID
|
PartnerType.PartnerTypeID | integer |
パートナー タイプの識別番号。 |
|
PartnerTypeName
|
PartnerType.PartnerTypeName | string |
パートナー タイプ名。 |
|
OfficeID
|
OfficeID | integer |
事務所 ID 番号。 |
|
PartnerName
|
PartnerName | string |
パートナー名。 |
|
住所1
|
MailingAddress.Address1 | string |
通りの番号と名前。 |
|
住所2
|
MailingAddress.Address2 | string |
さらなる住所情報。 |
|
都市
|
MailingAddress.City | string |
市区町村の名前。 |
|
状態
|
MailingAddress.State | string |
2 文字の州の省略形。 |
|
郵便番号
|
MailingAddress.Zip | string |
ZIP コードです。 |
|
PhoneNumber
|
ContactInformation.PhoneNumber | string |
パートナーの電話番号。 |
|
HomePhoneNumber
|
ContactInformation.HomePhoneNumber | string |
パートナーの電話番号。 |
|
CellPhoneNumber
|
ContactInformation.CellPhoneNumber | string |
パートナーの携帯番号。 |
|
ボイスメール
|
ContactInformation.Voicemail | string |
パートナーのバイスメール番号。 |
|
FaxNumber
|
ContactInformation.FaxNumber | string |
パートナー FAX 番号。 |
|
EmailAddress
|
ContactInformation.EmailAddress | string |
パートナーのメール アドレス。 |
|
PreferredCommunicationMethod
|
ContactInformation.PreferredCommunicationMethod | string |
パートナーの好ましいコミュケーション方法。 |
|
Web サイト
|
ContactInformation.Website | string |
パートナーの Web サイトの URL。 |
指定された検索条件からファイルを取得
指定された検索条件に基づいて、ファイルとその情報のリストを取得します。
パラメーター
| 名前 | キー | 必須 | 型 | 説明 |
|---|---|---|---|---|
|
FileNumber
|
FileNumber | string |
ファイル番号。 |
|
|
FileID
|
FileID | integer |
ファイルの識別番号。 |
|
|
OfficeID
|
OfficeID | integer |
事務所 ID 番号。 |
|
|
ClientsFileNumber
|
ClientsFileNumber | string |
クライアントのファイル番号。 |
|
|
TransactionTypeID
|
TransactionTypeID | integer |
トランザクション タイプの識別番号。 |
|
|
ProductTypeID
|
ProductTypeID | integer |
製品タイプの識別番号。 |
|
|
StatusID
|
StatusID | integer |
ステータスの識別番号。 |
|
|
件名
|
Name | string |
状態の名前です。 |
|
|
PolicyNumber
|
PolicyNumber | string |
ポリシー番号。 |
|
|
SearchNumber
|
SearchNumber | string |
検索番号。 |
|
|
LoanNumber
|
LoanNumber | string |
融資番号。 |
|
|
IsPrimary
|
IsPrimary | boolean |
これがプライマリ プロパティのアドレスであるかどうか。 |
|
|
StreetNumber
|
StreetNumber | string |
通りの番号。 |
|
|
StreetName
|
StreetName | string |
通りの番号。 |
|
|
都市
|
City | string |
市区町村の名前。 |
|
|
状態
|
State | string |
2 文字の州の省略形。 |
|
|
郵便番号
|
Zip | string |
ZIP コードです。 |
|
|
区分
|
Subdivision | string |
プロパティが位置する区分。 |
|
|
ParcelID
|
ParcelID | string |
区画の識別番号。 |
|
|
EntityType
|
EntityType | string |
エンティティの種類。 |
|
|
最初
|
First | string |
パーティー名。 |
|
|
最後
|
Last | string |
パーティーの姓。 |
|
|
UsePropertyAddress
|
UsePropertyAddress | boolean |
これがプライマリ プロパティのアドレスであるかどうか。 |
|
|
MaritalStatus
|
MaritalStatus | string |
パーティーの婚姻区分。 |
|
|
UserID
|
UserID | integer |
ユーザーの識別番号。 |
|
|
PartnerTypeID
|
PartnerTypeID | integer |
パートナー タイプの識別番号。 |
|
|
PartnerID
|
PartnerID | integer |
パートナー タイプの識別番号。 |
|
|
PartnerTypeID
|
PartnerTypeID | integer |
パートナー タイプの識別番号。 |
|
|
OpenedFromDate
|
OpenedFromDate | string |
ファイルが開けられた日付。 |
|
|
OpenedToDate
|
OpenedToDate | string |
ファイルが閉じられた日付。 |
戻り値
- 返答
- object
新しいファイルを作成
新しいファイルを作成します。
パラメーター
| 名前 | キー | 必須 | 型 | 説明 |
|---|---|---|---|---|
|
EntityType
|
EntityType | string |
エンティティ タイプの名前。 個人・法人等 |
|
|
IsPrimaryTransactee
|
IsPrimaryTransactee | boolean |
購入者が一時取引先なのかどうか。 |
|
|
最初
|
First | string |
購入者の名。 |
|
|
最後
|
Last | string |
購入者の姓。 |
|
|
UsePropertyAddress
|
UsePropertyAddress | boolean |
メールアドレスを新しいファイルのプロパティ アドレスとして使用するかどうか。 |
|
|
住所1
|
Address1 | string |
通りの番号と名前。 |
|
|
都市
|
City | string |
市区町村の名前。 |
|
|
状態
|
State | string |
2 文字の州の省略形。 |
|
|
郵便番号
|
Zip | string |
ZIP コードです。 |
|
|
MaritalStatus
|
MaritalStatus | string |
購入者の婚姻区分。 |
|
|
メール
|
string |
購入者のメール アドレス。 |
||
|
EntityType
|
EntityType | string |
エンティティ タイプの名前。 個人・法人等 |
|
|
IsPrimaryTransactee
|
IsPrimaryTransactee | boolean |
販売者が一時取引先なのかどうか。 |
|
|
最初
|
First | string |
販売者の名。 |
|
|
最後
|
Last | string |
販売者の姓。 |
|
|
UsePropertyAddress
|
UsePropertyAddress | boolean |
メールアドレスを新しいファイルのプロパティ アドレスとして使用するかどうか。 |
|
|
住所1
|
Address1 | string |
通りの番号と名前。 |
|
|
都市
|
City | string |
市区町村の名前。 |
|
|
状態
|
State | string |
2 文字の州の省略形。 |
|
|
郵便番号
|
Zip | string |
ZIP コードです。 |
|
|
MaritalStatus
|
MaritalStatus | string |
販売者の婚姻区分。 |
|
|
メール
|
string |
販売者のメール アドレス。 |
||
|
EstimatedSettlementDate
|
EstimatedSettlementDate | string |
注文の決済予定日。 |
|
|
TransactionTypeID
|
TransactionTypeID | integer |
トランザクション タイプの識別番号。 |
|
|
ProductTypeID
|
ProductTypeID | integer |
製品タイプの識別番号。 |
|
|
SalesPrice
|
SalesPrice | integer |
プロパティの販売価格。 |
|
|
ClientFileNumber
|
ClientFileNumber | string |
クライアントのファイル番号。 |
|
|
PiggybackFileNumber
|
PiggybackFileNumber | string |
piggyback ファイル番号。 |
|
|
MainFileNumber
|
MainFileNumber | string |
メイン ファイル番号。 |
|
|
SourceOfBusinessID
|
SourceOfBusinessID | integer |
ビジネス識別番号のソース。 |
|
|
注意
|
Note | string |
新規ファイルに追加するメモ。 |
|
|
件名
|
Name | string |
カスタム フィールドの名前。 |
|
|
価値
|
Value | string |
カスタム フィールドの値 |
|
|
LienPosition
|
LienPosition | integer |
先取特権。 |
|
|
LoanNumber
|
LoanNumber | string |
融資番号。 |
|
|
LoanAmount
|
LoanAmount | integer |
ローンの金額。 |
|
|
LoanType
|
LoanType | string |
ローン タイプ。 |
|
|
IsPrimary
|
IsPrimary | boolean |
これがプライマリ プロパティのアドレスであるかどうか。 |
|
|
StreetNumber
|
StreetNumber | string |
通りの番号。 |
|
|
StreetName
|
StreetName | string |
通りの番号。 |
|
|
都市
|
City | string |
市区町村の名前。 |
|
|
状態
|
State | string |
2 文字の州の省略形。 |
|
|
国
|
County | string |
プロパティが位置する国。 |
|
|
郵便番号
|
Zip | string |
ZIP コードです。 |
戻り値
| 名前 | パス | 型 | 説明 |
|---|---|---|---|
|
FileID
|
FileID | integer |
新しいファイルの識別番号。 |
|
FileNumber
|
FileNumber | string |
新しいファイルのファイル番号。 |
|
警告
|
Warnings | array of string |
新しいファイルに関する警告。 |
特定のドキュメントのカスタム フィールドを取得
特定のドキュメントのカスタム フィールドを取得します。
パラメーター
| 名前 | キー | 必須 | 型 | 説明 |
|---|---|---|---|---|
|
ファイル ID
|
FileID | True | string |
ファイル ID 番号。 |
|
Document ID
|
DocumentID | True | string |
ドキュメントの識別番号。 |
戻り値
| 名前 | パス | 型 | 説明 |
|---|---|---|---|
|
CustomFields
|
CustomFields | array of object |
カスタム フィールド。 |
|
件名
|
CustomFields.Name | string |
カスタム フィールドの名前。 |
|
価値
|
CustomFields.Value | string |
カスタム フィールドの値。 |
|
CustomFieldListCount
|
CustomFieldListCount | integer |
ファイルのカスタム フィールド番号。 |
特定のドキュメントのカスタム フィールドを追加または更新する
指定されたファイルで指定されたドキュメントのカスタム フィールドを追加または更新します。
パラメーター
| 名前 | キー | 必須 | 型 | 説明 |
|---|---|---|---|---|
|
ファイル ID
|
FileID | True | string |
ファイル ID 番号。 |
|
Document ID
|
DocumentID | True | string |
ドキュメントの識別番号。 |
|
件名
|
Name | string |
カスタム フィールドの名前。 |
|
|
価値
|
Value | string |
カスタム フィールドの値。 |
戻り値
- 返答
- object
特定のファイルでカスタム フィールドを追加または更新する
指定されたファイルのカスタム フィールドを追加または更新します。
パラメーター
| 名前 | キー | 必須 | 型 | 説明 |
|---|---|---|---|---|
|
ファイル ID
|
FileID | True | string |
ファイル ID 番号。 |
|
件名
|
Name | string |
カスタム フィールドの名前。 |
|
|
価値
|
Value | string |
カスタム フィールドの値。 |
戻り値
- 返答
- object
特定のファイルに新しいドキュメントを作成
特定のファイルに新しいドキュメントを作成します。
パラメーター
| 名前 | キー | 必須 | 型 | 説明 |
|---|---|---|---|---|
|
ファイル ID
|
FileID | True | string |
ファイル ID 番号。 |
|
DocumentName
|
DocumentName | string |
ドキュメント名。 |
|
|
DocumentTypeID
|
DocumentTypeID | integer |
ドキュメント タイプの識別番号。 |
|
|
説明設定
|
Description | string |
ドキュメントの説明。 |
|
|
InternalOnly
|
InternalOnly | string |
ドキュメントが内部のみなのかどうか。 |
|
|
DocumentBody
|
DocumentBody | string |
ドキュメントの本文。 |
戻り値
| 名前 | パス | 型 | 説明 |
|---|---|---|---|
|
DocumentID
|
Document.DocumentID | integer |
ドキュメントの識別番号。 |
特定のファイルのカスタム フィールド取得
指定されたファイルのカスタム フィールドを取得します。
パラメーター
| 名前 | キー | 必須 | 型 | 説明 |
|---|---|---|---|---|
|
ファイル ID
|
FileID | True | string |
ファイル ID 番号。 |
戻り値
| 名前 | パス | 型 | 説明 |
|---|---|---|---|
|
CustomFields
|
CustomFields | array of object |
ファイルのカスタム フィールドの一覧。 |
|
件名
|
CustomFields.Name | string |
カスタム フィールドの名前。 |
|
価値
|
CustomFields.Value | string |
カスタム フィールドの値。 |
|
CustomFieldListCount
|
CustomFieldListCount | integer |
ファイルのカスタム フィールド番号。 |
特定のファイルのパートナーを削除
指定されたファイルからパートナーを削除します。
パラメーター
| 名前 | キー | 必須 | 型 | 説明 |
|---|---|---|---|---|
|
ファイル ID
|
FileID | True | string |
ファイル ID 番号。 |
|
PartnerTypeID
|
PartnerTypeID | integer |
パートナー タイプの識別番号。 |
|
|
PartnerID
|
PartnerID | integer |
パートナー タイプの識別番号。 |
|
|
PartnerTypeID
|
PartnerTypeID | integer |
パートナー タイプの識別番号。 |
戻り値
- 返答
- object
特定ファイルのアクションを取得
指定されたファイルに対するすべてのアクションを取得します。
パラメーター
| 名前 | キー | 必須 | 型 | 説明 |
|---|---|---|---|---|
|
ファイル ID
|
FileID | True | string |
ファイル ID 番号。 |
戻り値
| 名前 | パス | 型 | 説明 |
|---|---|---|---|
|
Actions
|
Actions | array of object |
アクションの一覧。 |
|
FileActionID
|
Actions.FileActionID | integer |
ファイル アクションの識別番号。 |
|
ActionTypeID
|
Actions.ActionType.ActionTypeID | integer |
アクション タイプの識別番号。 |
|
件名
|
Actions.ActionType.Name | string |
アクション名。 |
|
表示名
|
Actions.ActionType.DisplayName | string |
表示名。 |
|
ActionGroupID
|
Actions.Group.ActionGroupID | integer |
アクション グループの識別番号。 |
|
件名
|
Actions.Group.Name | string |
アクション名。 |
|
CoordinatorTypeID
|
Actions.StartTask.CoordinatorTypeID | integer |
コーディネーター タイプの識別番号。 |
|
DueDate
|
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 |
ユーザーの識別番号。 |
|
件名
|
Actions.StartTask.DoneBy.Name | string |
ユーザー名。 |
|
CoordinatorTypeID
|
Actions.CompleteTask.CoordinatorTypeID | integer |
コーディネーター タイプの識別番号。 |
|
DueDate
|
Actions.CompleteTask.DueDate | string |
アクションの期限。 |
|
DueDateLocked
|
Actions.CompleteTask.DueDateLocked | boolean |
期限がロック済みかどうか。 |
|
DoneDateLocked
|
Actions.CompleteTask.DoneDateLocked | boolean |
完了日がロック済みかどうか。 |
|
UserID
|
Actions.CompleteTask.DoneBy.UserID | integer |
ユーザーの識別番号。 |
|
件名
|
Actions.CompleteTask.DoneBy.Name | string |
ユーザーの名前。 |
特定ファイルのドキュメントを取得
指定されたファイルのドキュメントに関するすべての情報を取得します。
パラメーター
| 名前 | キー | 必須 | 型 | 説明 |
|---|---|---|---|---|
|
ファイル ID
|
FileID | True | string |
ファイル ID 番号。 |
戻り値
| 名前 | パス | 型 | 説明 |
|---|---|---|---|
|
Documents
|
Documents | array of object |
ファイルのドキュメントの一覧。 |
|
DocumentID
|
Documents.DocumentID | integer |
ドキュメントの識別番号。 |
|
DocumentName
|
Documents.DocumentName | string |
ドキュメント名。 |
|
DocumentTypeID
|
Documents.DocumentType.DocumentTypeID | integer |
ドキュメント タイプの識別番号。 |
|
件名
|
Documents.DocumentType.Name | string |
ドキュメント タイプ名。 |
|
説明設定
|
Documents.Description | string |
ドキュメントの説明。 |
|
InternalOnly
|
Documents.InternalOnly | boolean |
ドキュメントが内部のみなのかどうか。 |
|
Approved
|
Documents.Approved | boolean |
ドキュメントが承認されたかどうか。 |
|
AssociatedNotes
|
Documents.AssociatedNotes | array of object |
ドキュメントに関連付けたメモ。 |
|
NoteID
|
Documents.AssociatedNotes.NoteID | integer |
メモの識別番号。 |
|
UserID
|
Documents.CreateUser.UserID | integer |
ユーザーの識別番号。 |
|
件名
|
Documents.CreateUser.Name | string |
ユーザーの名前。 |
|
CreateDate
|
Documents.CreateDate | string |
ドキュメントが作成された日付。 |
|
UserID
|
Documents.ModifyUser.UserID | integer |
ユーザーの識別番号。 |
|
件名
|
Documents.ModifyUser.Name | string |
ユーザーの名前。 |
|
ModifyDate
|
Documents.ModifyDate | string |
ドキュメントの変更日。 |
特定ファイルのパーティーを取得
指定されたファイルのパーティーの一覧と情報を取得します。
パラメーター
| 名前 | キー | 必須 | 型 | 説明 |
|---|---|---|---|---|
|
ファイル ID
|
FileID | True | string |
ファイル ID 番号。 |
戻り値
| 名前 | パス | 型 | 説明 |
|---|---|---|---|
|
購買担当者
|
Buyers | array of object |
購入者に関する情報。 |
|
LegalEntityID
|
Buyers.LegalEntityID | integer |
法人の識別番号。 |
|
EntityType
|
Buyers.EntityType | string |
エンティティ タイプの名前。 |
|
接頭辞
|
Buyers.Primary.Prefix | string |
購入者の敬称。 |
|
最初
|
Buyers.Primary.First | string |
購入者名。 |
|
中央揃え
|
Buyers.Primary.Middle | string |
購入者のミドル ネーム。 |
|
最後
|
Buyers.Primary.Last | string |
購入者の姓。 |
|
Suffix
|
Buyers.Primary.Suffix | string |
購入者の敬称。 |
|
接頭辞
|
Buyers.Secondary.Prefix | string |
二次購入者の敬称。 |
|
最初
|
Buyers.Secondary.First | string |
二次購入者名。 |
|
中央揃え
|
Buyers.Secondary.Middle | string |
二次購入者のミドル ネーム。 |
|
最後
|
Buyers.Secondary.Last | string |
二次購入者の姓。 |
|
UsePropertyAddress
|
Buyers.UsePropertyAddress | boolean |
アドレスを使用するかどうか。 |
|
住所1
|
Buyers.Address.Address1 | string |
通りの番号と名前。 |
|
都市
|
Buyers.Address.City | string |
市区町村の名前。 |
|
状態
|
Buyers.Address.State | string |
2 文字の州の省略形。 |
|
郵便番号
|
Buyers.Address.Zip | string |
ZIP コードです。 |
|
MaritalStatus
|
Buyers.MaritalStatus | string |
パーティーの婚姻区分。 |
|
メール
|
Buyers.Email | string |
パーティーのメール アドレス。 |
|
HomePhone
|
Buyers.HomePhone | string |
パーティーの自宅電話番号。 |
|
EmailSecondary
|
Buyers.EmailSecondary | string |
二次パーティーのメール アドレス。 |
|
販売担当者
|
Sellers | array of object |
販売者に関する情報。 |
|
LegalEntityID
|
Sellers.LegalEntityID | integer |
法人の識別番号。 |
|
EntityType
|
Sellers.EntityType | string |
エンティティの種類。 |
|
BusinessName
|
Sellers.Primary.BusinessName | string |
会社名。 |
|
UsePropertyAddress
|
Sellers.UsePropertyAddress | boolean |
アドレスを使用するかどうか。 |
|
住所1
|
Sellers.Address.Address1 | string |
通りの番号と名前。 |
|
都市
|
Sellers.Address.City | string |
市区町村の名前。 |
|
状態
|
Sellers.Address.State | string |
2 文字の州の省略形。 |
|
郵便番号
|
Sellers.Address.Zip | string |
ZIP コードです。 |
|
MaritalStatus
|
Sellers.MaritalStatus | string |
パーティーの婚姻区分。 |
|
メール
|
Sellers.Email | string |
パーティーのメール アドレス。 |
|
Customers
|
Customers | array of string |
顧客に関する情報。 |
特定ファイルのパートナーを取得
指定されたファイルのパートナーの一覧と情報を取得します。
パラメーター
| 名前 | キー | 必須 | 型 | 説明 |
|---|---|---|---|---|
|
ファイル ID
|
FileID | True | string |
ファイル ID 番号。 |
戻り値
| 名前 | パス | 型 | 説明 |
|---|---|---|---|
|
パートナー
|
Partners | array of object |
パートナーに関する情報。 |
|
UserID
|
Partners.PrimaryEmployee.UserID | integer |
ユーザーの識別番号。 |
|
件名
|
Partners.PrimaryEmployee.Name | string |
従業員の氏名。 |
|
FirstName
|
Partners.PrimaryEmployee.FirstName | string |
従業員の名。 |
|
LastName
|
Partners.PrimaryEmployee.LastName | string |
従業員の姓。 |
|
PhoneNumber
|
Partners.PrimaryEmployee.ContactInformation.PhoneNumber | string |
従業員の電話番号。 |
|
EmailAddress
|
Partners.PrimaryEmployee.ContactInformation.EmailAddress | string |
従業員のメール アドレス。 |
|
PartnerTypeID
|
Partners.PartnerTypeID | integer |
パートナー タイプの識別番号。 |
|
PartnerID
|
Partners.PartnerID | integer |
パートナー タイプの識別番号。 |
|
PartnerTypeID
|
Partners.PartnerType.PartnerTypeID | integer |
パートナー タイプの識別番号。 |
|
PartnerTypeName
|
Partners.PartnerType.PartnerTypeName | string |
パートナー タイプ名。 |
|
PartnerName
|
Partners.PartnerName | string |
パートナー名。 |
特定ファイルのメモを取得
指定したファイルのメモの一覧を取得します。
パラメーター
| 名前 | キー | 必須 | 型 | 説明 |
|---|---|---|---|---|
|
ファイル ID
|
FileID | True | string |
ファイル ID 番号。 |
戻り値
| 名前 | パス | 型 | 説明 |
|---|---|---|---|
|
ノート
|
Notes | array of object |
ファイルでメモの一覧。 |
|
NoteID
|
Notes.NoteID | integer |
メモの識別番号。 |
|
サブジェクト
|
Notes.Subject | string |
メモの件名。 |
|
Body
|
Notes.Body | string |
メモの本文。 |
|
UserID
|
Notes.CreatedBy.UserID | integer |
ユーザーの識別番号。 |
|
件名
|
Notes.CreatedBy.Name | string |
ユーザーの氏名。 |
|
FirstName
|
Notes.CreatedBy.FirstName | string |
ユーザーの名です。 |
|
LastName
|
Notes.CreatedBy.LastName | string |
ユーザーの姓です。 |
|
PhoneNumber
|
Notes.CreatedBy.ContactInformation.PhoneNumber | string |
ユーザーの電話番号。 |
|
EmailAddress
|
Notes.CreatedBy.ContactInformation.EmailAddress | string |
ユーザーのメール アドレス。 |
|
CreatedDate
|
Notes.CreatedDate | string |
メモを作成した日付。 |
|
FileID
|
Notes.FileID | integer |
ファイルの識別番号。 |
|
急送
|
Notes.Expedite | boolean |
メモが優先されたかどうか。 |
現在のユーザー情報を取得する
現在接続しているユーザーの情報を取得します。
戻り値
| 名前 | パス | 型 | 説明 |
|---|---|---|---|
|
肩書き
|
Title | string |
ユーザーのタイトルです。 |
|
PasswordExpirationDate
|
PasswordExpirationDate | string |
パスワードが切れる日付です。 |
|
UserID
|
UserID | integer |
ユーザーの識別番号。 |
|
件名
|
Name | string |
ユーザーの名前。 |
|
FirstName
|
FirstName | string |
ユーザーの名です。 |
|
LastName
|
LastName | string |
ユーザーの姓です。 |
|
CellPhoneNumber
|
ContactInformation.CellPhoneNumber | string |
ユーザーの携帯番号。 |
|
EmailAddress
|
ContactInformation.EmailAddress | string |
ユーザーのメール アドレス。 |
|
PreferredCommunicationMethod
|
ContactInformation.PreferredCommunicationMethod | string |
ユーザーが好むコミュニケーション方法。 |
|
PhoneNumber
|
ContactInformation.PhoneNumber | string |
ユーザーの電話番号です。 |
|
FaxNumber
|
ContactInformation.FaxNumber | string |
ユーザーの FAX 番号。 |
|
Web サイト
|
ContactInformation.Website | string |
ユーザー Web サイト。 |
見積もりと発注のためのトランザクションと製品タイプを取得
料金の見積もりと発注のためのトランザクションと製品タイプを取得します。
パラメーター
| 名前 | キー | 必須 | 型 | 説明 |
|---|---|---|---|---|
|
状態
|
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 |
製品タイプの識別番号。 |
定義
オブジェクト
’オブジェクト’ という種類です。