InfoQuery
O InfoQuery permite automatizar sua empresa aproveitando os dados do Resware em uma solução de baixo código. Você pode exibir, criar, excluir e atualizar arquivos, documentos, parceiros etc.
Esse conector está disponível nos seguintes produtos e regiões:
| Service | Class | Regions |
|---|---|---|
| Copilot Studio | Premium | Todas as regiões do Power Automate , exceto as seguintes: – Governo dos EUA (GCC) – Governo dos EUA (GCC High) - China Cloud operado pela 21Vianet - Departamento de Defesa dos EUA (DoD) |
| Aplicativos Lógicos | Standard | Todas as regiões dos Aplicativos Lógicos , exceto as seguintes: – Regiões do Azure Governamental - Regiões do Azure China - Departamento de Defesa dos EUA (DoD) |
| Power Apps | Premium | Todas as regiões do Power Apps , exceto as seguintes: – Governo dos EUA (GCC) – Governo dos EUA (GCC High) - China Cloud operado pela 21Vianet - Departamento de Defesa dos EUA (DoD) |
| Power Automate | Premium | Todas as regiões do Power Automate , exceto as seguintes: – Governo dos EUA (GCC) – Governo dos EUA (GCC High) - China Cloud operado pela 21Vianet - Departamento de Defesa dos EUA (DoD) |
| Contato | |
|---|---|
| Nome | Suporte do InfoQuery |
| URL | https://infoquery.pro/support/ |
| support@infoquery.pro |
| Metadados do conector | |
|---|---|
| Publicador | InfoQuery LLC |
| Site | https://infoquery.pro/ |
| Política de privacidade | https://infoquery.pro/privacy/ |
| Categorias | Conteúdo e arquivos; Dados |
O Gerenciador de Títulos do InfoQuery permite automatizar as alterações no sistema Resware. Você terá a capacidade de adicionar, excluir ou editar arquivos, ações, anotações, documentos etc.
Pré-requisitos
- A chave de API é necessária, deve se inscrever em https://connector.infoquery.pro/
- Uma conta do Resware também é necessária. O nome de usuário, a senha e a URL do portal serão necessários para formar a conexão.
Como obter credenciais
- Vá para https://connector.infoquery.pro/signup e crie uma conta. A partir daqui, você pode escolher uma assinatura de sua escolha, a chave de API será fornecida após a seleção.
- Visite para obter https://connector.infoquery.pro/products detalhes de assinatura e preços.
- Os detalhes da conta de resware serão fornecidos pelo administrador do Resware.
Introdução ao conector
- Vá para o Power Automate em https://powerautomate.microsoft.com.
- Crie um novo fluxo ou edite um fluxo existente.
- Adicione uma nova etapa ao fluxo, pesquise pelo Gerenciador de Títulos do InfoQuery para ver todas as ações disponíveis.
- Depois de selecionar a ação, você precisará criar uma nova conexão.
- Insira o nome da conexão, a chave de API, o nome de usuário do Resware, a senha e a URL do portal. A URL do portal deve estar no formato de https://portal.infoquery.com/API.
- Entre em contato support@infoquery.pro ou visite https://infoquery.pro/support/ se a assistência for necessária.
Problemas e limitações conhecidos
Cada empresa que utiliza o Resware tem a capacidade de personalizá-lo para atender às suas necessidades específicas. Dependendo da configuração do Resware, determinadas ações podem exigir informações específicas para que o conector funcione corretamente. O conhecimento do sistema resware será necessário.
Erros e soluções comuns
As ações podem dar uma resposta de 200, mas as informações esperadas não são retornadas. Isso provavelmente ocorrerá devido às informações necessárias de sua configuração específica do Resware não serem fornecidas. As informações fornecidas foram enviadas com êxito ao Resware, dando a resposta 200, mas as ações podem não ter ocorrido conforme o esperado. O administrador ou portal do Resware poderá fornecer as informações necessárias para concluir as ações.
perguntas frequentes
Onde encontro minha URL do portal do Resware?
O administrador do Resware fornecerá a URL do portal.
Como fazer para obter uma chave de API?
Vá para https://connector.infoquery.pro/signup e crie uma conta. A partir daqui, você pode escolher uma assinatura de sua escolha, a chave de API será fornecida após a seleção.
Criando uma conexão
O conector dá suporte aos seguintes tipos de autenticação:
| Default | Parâmetros para criar conexão. | Todas as regiões | Não compartilhável |
Padrão
Aplicável: todas as regiões
Parâmetros para criar conexão.
Essa não é uma conexão compartilhável. Se o aplicativo de energia for compartilhado com outro usuário, outro usuário será solicitado a criar uma nova conexão explicitamente.
| Nome | Tipo | Description | Obrigatório |
|---|---|---|---|
| Chave de API | secureString | A chave de API para esta api | Verdade |
| Nome de usuário do ResWare | cadeia | O nome de usuário do ResWare | Verdade |
| ResWare Password | secureString | A senha do ResWare | Verdade |
| ResWare Portal URL | cadeia | A URL do portal para ResWare | Verdade |
Limitações
| Nome | Chamadas | Período de renovação |
|---|---|---|
| Chamadas à API por conexão | 100 | 60 segundos |
Ações
| Adicionar anotação ao arquivo |
Adiciona uma nova anotação ao arquivo especificado. |
| Adicionar ação ao arquivo |
Adiciona uma ação ao arquivo especificado. |
| Adicionar novo funcionário parceiro à empresa parceira |
Adiciona um novo funcionário parceiro a uma empresa parceira. |
| Adicionar ou atualizar o campo personalizado em um arquivo específico |
Adiciona ou atualiza campos personalizados no arquivo especificado. |
| Adicionar ou atualizar o campo personalizado em um documento específico |
Adiciona ou atualiza campos personalizados no documento especificado no arquivo especificado. |
| Adicionar parceiro a um arquivo específico |
Adiciona um parceiro ao arquivo especificado. |
| Atualizar a ação para arquivo |
Atualiza uma ação para um determinado arquivo. Pode atualizar a ID do Grupo de Ações e iniciar/concluir a ID do tipo coordenador, a ID do tipo do parceiro, a data de conclusão, a data de conclusão bloqueada e a data de término bloqueadas. Essa chamada à API não pode ser usada para marcar uma ação como iniciada ou concluída. |
| Atualizar Funcionário do Parceiro |
Atualiza as informações de um funcionário parceiro. |
| Atualizar informações do parceiro para um arquivo específico |
Atualiza as informações do parceiro no arquivo especificado. |
| Cancela pedido feito anteriormente |
Cancela um pedido feito anteriormente. |
| Carregar documento da URL da Web para um arquivo específico |
Carrega o documento da URL da Web no arquivo especificado. |
| Criar novo arquivo |
Cria um arquivo novo. |
| Criar novo documento em um arquivo específico |
Cria um novo documento no arquivo especificado. |
| Estimativa de Taxa de Fechamento |
Estima as taxas de fechamento. |
| Excluir parceiro em um arquivo específico |
Remove um parceiro do arquivo especificado. |
| Excluir pedido feito anteriormente |
Cancela um pedido feito anteriormente. |
| Obter anotações para um arquivo específico |
Obtém uma lista das anotações no arquivo especificado. |
| Obter ações para um arquivo específico |
Obtém todas as ações no arquivo especificado. |
| Obter campos personalizados em um documento específico |
Obtenha os campos personalizados no documento especificado. |
| Obter campos personalizados para um arquivo específico |
Obtém os campos personalizados para o arquivo especificado. |
| Obter Documento |
Obtém informações sobre um documento com a ID especificada. |
| Obter documentos para um arquivo específico |
Obtém todas as informações sobre os documentos no arquivo especificado. |
| Obter informações do parceiro |
Obtém informações sobre um parceiro com a ID especificada. |
| Obter informações do usuário atual |
Obtém as informações sobre o usuário conectado no momento. |
| Obter Nota |
Obtém a nota com a ID especificada. |
| Obter parceiros para um arquivo específico |
Obtém uma lista de parceiros e suas informações no arquivo especificado. |
| Obter partes para um arquivo específico |
Obtém uma lista das partes e suas informações no arquivo especificado. |
| Obter PDF do Recibo de Estimativa de Taxa de Fechamento |
Obtém o recibo de estimativa de taxa de fechamento no formato pdf. |
| Obter recibo de estimativa de taxa de fechamento |
Obtém o recibo de estimativa de taxa de fechamento. |
| Obter tipos de transação e produto para estimativa e posicionamento de pedidos |
Obtenha tipos de transação e tipos de produto para estimativa de taxa e fazer pedidos. |
| Obtém arquivos de determinados critérios de pesquisa |
Obtém uma lista de arquivos e suas informações com base nos critérios de pesquisa especificados. |
Adicionar anotação ao arquivo
Adiciona uma nova anotação ao arquivo especificado.
Parâmetros
| Nome | Chave | Obrigatório | Tipo | Description |
|---|---|---|---|---|
|
ID de Arquivo
|
FileID | True | string |
Número de identificação do arquivo. |
|
Assunto
|
Subject | string |
O assunto da anotação. |
|
|
Corpo
|
Body | string |
O corpo da anotação. |
Retornos
| Nome | Caminho | Tipo | Description |
|---|---|---|---|
|
NoteID
|
note.NoteID | integer |
O número de identificação da anotação. |
Adicionar ação ao arquivo
Adiciona uma ação ao arquivo especificado.
Parâmetros
| Nome | Chave | Obrigatório | Tipo | Description |
|---|---|---|---|---|
|
ID de Arquivo
|
FileID | True | string |
Número de identificação do arquivo. |
|
ActionTypeID
|
ActionTypeID | integer |
O número de identificação do tipo de ação. |
|
|
ActionGroupID
|
ActionGroupID | integer |
O número de identificação do grupo de ações. |
|
|
CoordinatorTypeID
|
CoordinatorTypeID | integer |
O número de identificação do tipo coordenador. |
|
|
Data de Conclusão
|
DueDate | string |
A data de conclusão da ação. |
|
|
PartnerTypeID
|
PartnerTypeID | integer |
O número de identificação do tipo de parceiro. |
|
|
Data de Conclusão
|
DueDate | string |
A data de conclusão da ação. |
Retornos
| Nome | Caminho | Tipo | Description |
|---|---|---|---|
|
FileActionID
|
FileActionID | integer |
O número de identificação da ação do arquivo. |
Adicionar novo funcionário parceiro à empresa parceira
Adiciona um novo funcionário parceiro a uma empresa parceira.
Parâmetros
| Nome | Chave | Obrigatório | Tipo | Description |
|---|---|---|---|---|
|
ID da Empresa de Parceiros
|
PartnerCompanyID | True | string |
Número de identificação da empresa parceira. |
|
Senha
|
Password | string |
Senha para o novo funcionário. |
|
|
PasswordExpirationDate
|
PasswordExpirationDate | string |
A data em que a senha expirará. |
|
|
Enabled
|
Enabled | boolean |
Se o novo funcionário será habilitado ou não para uso. |
|
|
WebsiteAccess
|
WebsiteAccess | boolean |
Se o novo funcionário tem ou não acesso ao site. |
|
|
Nome
|
Name | string |
O nome completo do novo funcionário. |
|
|
Primeiro Nome
|
FirstName | string |
O nome do novo funcionário. |
|
|
LastName
|
LastName | string |
O sobrenome do novo funcionário. |
|
|
Endereço de Email
|
EmailAddress | string |
O endereço de email do novo funcionário. |
Retornos
| Nome | Caminho | Tipo | Description |
|---|---|---|---|
|
PartnerCompanyID
|
Employee.PartnerCompanyID | integer |
O número de identificação da empresa parceira. |
|
Enabled
|
Employee.Enabled | boolean |
Se o novo funcionário foi habilitado ou não para uso. |
|
WebsiteAccess
|
Employee.WebsiteAccess | boolean |
Se o funcionário tem ou não acesso ao site. |
|
UserID
|
Employee.UserID | integer |
O número de identificação do novo funcionário. |
|
Nome
|
Employee.Name | string |
O nome completo do funcionário. |
|
Primeiro Nome
|
Employee.FirstName | string |
O nome do funcionário. |
|
LastName
|
Employee.LastName | string |
O sobrenome do funcionário. |
|
Endereço de Email
|
Employee.ContactInformation.EmailAddress | string |
O endereço de email do funcionário. |
Adicionar ou atualizar o campo personalizado em um arquivo específico
Adiciona ou atualiza campos personalizados no arquivo especificado.
Parâmetros
| Nome | Chave | Obrigatório | Tipo | Description |
|---|---|---|---|---|
|
ID de Arquivo
|
FileID | True | string |
Número de identificação do arquivo. |
|
Nome
|
Name | string |
O nome do campo personalizado. |
|
|
Value
|
Value | string |
O valor do campo personalizado. |
Retornos
- response
- object
Adicionar ou atualizar o campo personalizado em um documento específico
Adiciona ou atualiza campos personalizados no documento especificado no arquivo especificado.
Parâmetros
| Nome | Chave | Obrigatório | Tipo | Description |
|---|---|---|---|---|
|
ID de Arquivo
|
FileID | True | string |
Número de identificação do arquivo. |
|
ID do documento
|
DocumentID | True | string |
Número de identificação do documento. |
|
Nome
|
Name | string |
O nome do campo personalizado. |
|
|
Value
|
Value | string |
O valor do campo personalizado. |
Retornos
- response
- object
Adicionar parceiro a um arquivo específico
Adiciona um parceiro ao arquivo especificado.
Parâmetros
| Nome | Chave | Obrigatório | Tipo | Description |
|---|---|---|---|---|
|
ID de Arquivo
|
FileID | True | string |
Número de identificação do arquivo. |
|
UserID
|
UserID | integer |
O número de identificação do usuário. |
|
|
UserID
|
UserID | integer |
O número de identificação do usuário. |
|
|
PartnerTypeID
|
PartnerTypeID | integer |
O número de identificação do tipo de parceiro. |
|
|
ID do Parceiro
|
PartnerID | integer |
O número de identificação do parceiro. |
|
|
PartnerTypeID
|
PartnerTypeID | integer |
O número de identificação do tipo de parceiro. |
Retornos
- response
- object
Atualizar a ação para arquivo
Atualiza uma ação para um determinado arquivo. Pode atualizar a ID do Grupo de Ações e iniciar/concluir a ID do tipo coordenador, a ID do tipo do parceiro, a data de conclusão, a data de conclusão bloqueada e a data de término bloqueadas. Essa chamada à API não pode ser usada para marcar uma ação como iniciada ou concluída.
Parâmetros
| Nome | Chave | Obrigatório | Tipo | Description |
|---|---|---|---|---|
|
ID de Arquivo
|
FileID | True | string |
Número de identificação do arquivo. |
|
ID da ação do arquivo
|
FileActionID | True | string |
Número de identificação da ação. |
|
CoordinatorTypeID
|
CoordinatorTypeID | integer |
O número de identificação do tipo coordenador. |
|
|
Data de Conclusão
|
DueDate | string |
A data de conclusão da ação. |
|
|
DoneDateLocked
|
DoneDateLocked | boolean |
Se a data concluída está bloqueada ou não. |
|
|
CoordinatorTypeID
|
CoordinatorTypeID | integer |
O número de identificação do tipo coordenador. |
|
|
Data de Conclusão
|
DueDate | string |
A data de conclusão da ação. |
|
|
DoneDateLocked
|
DoneDateLocked | boolean |
Se a data concluída está bloqueada ou não. |
Retornos
| Nome | Caminho | Tipo | Description |
|---|---|---|---|
|
FileActionID
|
FileActionID | integer |
O número de identificação da ação. |
Atualizar Funcionário do Parceiro
Atualiza as informações de um funcionário parceiro.
Parâmetros
| Nome | Chave | Obrigatório | Tipo | Description |
|---|---|---|---|---|
|
ID do Usuário
|
UserID | True | string |
Número de identificação do usuário. |
|
ID da Empresa de Parceiros
|
PartnerCompanyID | True | string |
Número de identificação da empresa parceira. |
|
Senha
|
Password | string |
A senha dos funcionários. |
|
|
PasswordExpirationDate
|
PasswordExpirationDate | string |
A data em que a senha expirará. |
|
|
RoleID
|
RoleID | integer |
O número de identificação da função. |
|
|
Nome
|
Name | string |
O nome da função. |
|
|
Enabled
|
Enabled | boolean |
Se o funcionário foi habilitado ou não para uso. |
|
|
WebsiteAccess
|
WebsiteAccess | boolean |
Se o funcionário tem ou não acesso ao site. |
|
|
Nome
|
Name | string |
O nome completo do funcionário. |
|
|
Primeiro Nome
|
FirstName | string |
O nome do funcionário. |
|
|
LastName
|
LastName | string |
O sobrenome do funcionário. |
|
|
Endereço de Email
|
EmailAddress | string |
O endereço de email do funcionário. |
Retornos
| Nome | Caminho | Tipo | Description |
|---|---|---|---|
|
PartnerCompanyID
|
Employee.PartnerCompanyID | integer |
O número de identificação da empresa parceira. |
|
Funções
|
Employee.Roles | array of object |
Funções do funcionário. |
|
RoleID
|
Employee.Roles.RoleID | integer |
O número de identificação da função. |
|
Nome
|
Employee.Roles.Name | string |
O nome da função. |
|
Enabled
|
Employee.Enabled | boolean |
Se o funcionário foi habilitado ou não para uso. |
|
WebsiteAccess
|
Employee.WebsiteAccess | boolean |
Se o funcionário tem ou não acesso ao site. |
|
UserID
|
Employee.UserID | integer |
O número de identificação do usuário. |
|
Nome
|
Employee.Name | string |
O nome completo do funcionário. |
|
Primeiro Nome
|
Employee.FirstName | string |
O nome do funcionário. |
|
LastName
|
Employee.LastName | string |
O sobrenome do funcionário. |
|
Endereço de Email
|
Employee.ContactInformation.EmailAddress | string |
O endereço de email do funcionário. |
Atualizar informações do parceiro para um arquivo específico
Atualiza as informações do parceiro no arquivo especificado.
Parâmetros
| Nome | Chave | Obrigatório | Tipo | Description |
|---|---|---|---|---|
|
ID de Arquivo
|
FileID | True | string |
Número de identificação do arquivo. |
|
ID de Parceiro
|
PartnerID | True | string |
Número de identificação do parceiro. |
|
FileID
|
FileID | integer |
O número de identificação do arquivo. |
|
|
UserID
|
UserID | integer |
O número de identificação do usuário. |
|
|
Nome
|
Name | string |
O nome completo do funcionário. |
|
|
Primeiro Nome
|
FirstName | string |
O nome do funcionário. |
|
|
LastName
|
LastName | string |
O sobrenome do funcionário. |
|
|
Número de telefone
|
PhoneNumber | string |
O número de telefone do funcionário. |
|
|
HomePhoneNumber
|
HomePhoneNumber | string |
O número de telefone da casa do funcionário. |
|
|
CellPhoneNumber
|
CellPhoneNumber | string |
O número do celular do funcionário. |
|
|
Caixa postal
|
Voicemail | string |
A caixa postal do funcionário. |
|
|
FaxNumber
|
FaxNumber | string |
O número de fax do funcionário. |
|
|
Endereço de Email
|
EmailAddress | string |
O endereço de email do funcionário. |
|
|
PreferredCommunicationMethod
|
PreferredCommunicationMethod | string |
O método de comunicação preferencial dos funcionários. |
|
|
Site
|
Website | string |
O link da Web do funcionário. |
|
|
UserID
|
UserID | integer |
O número de identificação do usuário. |
|
|
Nome
|
Name | string |
O nome completo do funcionário secundário. |
|
|
Primeiro Nome
|
FirstName | string |
O primeiro nome do funcionário secundário. |
|
|
LastName
|
LastName | string |
O sobrenome do funcionário secundário. |
|
|
Número de telefone
|
PhoneNumber | string |
O número de telefone do funcionário secundário. |
|
|
HomePhoneNumber
|
HomePhoneNumber | string |
O número de telefone residencial do funcionário secundário. |
|
|
CellPhoneNumber
|
CellPhoneNumber | string |
O número do celular do funcionário secundário. |
|
|
Caixa postal
|
Voicemail | string |
A caixa postal do funcionário secundário. |
|
|
FaxNumber
|
FaxNumber | string |
O número de fax do funcionário secundário. |
|
|
Endereço de Email
|
EmailAddress | string |
O endereço de email do funcionário secundário. |
|
|
PreferredCommunicationMethod
|
PreferredCommunicationMethod | string |
O método de comunicação preferencial dos funcionários secundários. |
|
|
Site
|
Website | string |
O link da Web do funcionário secundário. |
|
|
ReferenceNumber
|
ReferenceNumber | string |
O número de referência. |
|
|
RemoteFileNumber
|
RemoteFileNumber | string |
O número do arquivo remoto. |
|
|
PartnerTypeID
|
PartnerTypeID | integer |
O número de identificação do tipo de parceiro. |
|
|
ID do Parceiro
|
PartnerID | integer |
O número de identificação do parceiro. |
|
|
PartnerTypeID
|
PartnerTypeID | integer |
O número de identificação do tipo de parceiro. |
|
|
PartnerTypeName
|
PartnerTypeName | string |
O nome do tipo de parceiro. |
|
|
OfficeID
|
OfficeID | integer |
O número de identificação do escritório. |
|
|
PartnerName
|
PartnerName | string |
O nome do parceiro. |
|
|
Address1
|
Address1 | string |
O número e o nome da rua. |
|
|
Address2
|
Address2 | string |
Mais informações de endereço. |
|
|
City
|
City | string |
O nome da cidade. |
|
|
Estado
|
State | string |
A abreviação de estado de duas letras. |
|
|
Zip
|
Zip | string |
O CEP. |
|
|
Número de telefone
|
PhoneNumber | string |
O número de telefone do parceiro. |
|
|
HomePhoneNumber
|
HomePhoneNumber | string |
O número de telefone da casa do parceiro. |
|
|
CellPhoneNumber
|
CellPhoneNumber | string |
O número do celular do parceiro. |
|
|
Caixa postal
|
Voicemail | string |
O número da caixa postal do parceiro. |
|
|
FaxNumber
|
FaxNumber | string |
O número do fax do parceiro. |
|
|
Endereço de Email
|
EmailAddress | string |
O endereço de email do parceiro. |
|
|
PreferredCommunicationMethod
|
PreferredCommunicationMethod | string |
Os parceiros preferiram a forma de comunicação. |
|
|
Site
|
Website | string |
A URL do site do parceiro. |
Retornos
| Nome | Caminho | Tipo | Description |
|---|---|---|---|
|
FileID
|
FileID | integer |
O número de identificação do arquivo. |
|
FileNumber
|
FileNumber | string |
O número do arquivo |
|
UserID
|
PrimaryEmployee.UserID | integer |
O número de identificação do usuário. |
|
Nome
|
PrimaryEmployee.Name | string |
O nome completo do funcionário. |
|
Primeiro Nome
|
PrimaryEmployee.FirstName | string |
O nome do funcionário. |
|
LastName
|
PrimaryEmployee.LastName | string |
O sobrenome do funcionário. |
|
Número de telefone
|
PrimaryEmployee.ContactInformation.PhoneNumber | string |
O número de telefone do funcionário. |
|
HomePhoneNumber
|
PrimaryEmployee.ContactInformation.HomePhoneNumber | string |
O número de telefone da casa do funcionário. |
|
CellPhoneNumber
|
PrimaryEmployee.ContactInformation.CellPhoneNumber | string |
O número do celular do funcionário. |
|
Caixa postal
|
PrimaryEmployee.ContactInformation.Voicemail | string |
A caixa postal do funcionário. |
|
FaxNumber
|
PrimaryEmployee.ContactInformation.FaxNumber | string |
O número de fax do funcionário. |
|
Endereço de Email
|
PrimaryEmployee.ContactInformation.EmailAddress | string |
O endereço de email do funcionário. |
|
PreferredCommunicationMethod
|
PrimaryEmployee.ContactInformation.PreferredCommunicationMethod | string |
O método de comunicação preferencial dos funcionários. |
|
Site
|
PrimaryEmployee.ContactInformation.Website | string |
O link da Web do funcionário. |
|
SecondaryEmployees
|
SecondaryEmployees | array of object |
Informações sobre o funcionário secundário. |
|
UserID
|
SecondaryEmployees.UserID | integer |
O número de identificação do usuário. |
|
Nome
|
SecondaryEmployees.Name | string |
O nome completo do funcionário secundário. |
|
Primeiro Nome
|
SecondaryEmployees.FirstName | string |
O primeiro nome do funcionário secundário. |
|
LastName
|
SecondaryEmployees.LastName | string |
O sobrenome do funcionário secundário. |
|
Número de telefone
|
SecondaryEmployees.ContactInformation.PhoneNumber | string |
O número de telefone do funcionário secundário. |
|
HomePhoneNumber
|
SecondaryEmployees.ContactInformation.HomePhoneNumber | string |
O número de telefone residencial do funcionário secundário. |
|
CellPhoneNumber
|
SecondaryEmployees.ContactInformation.CellPhoneNumber | string |
O número do celular do funcionário secundário. |
|
Caixa postal
|
SecondaryEmployees.ContactInformation.Voicemail | string |
A caixa postal do funcionário secundário. |
|
FaxNumber
|
SecondaryEmployees.ContactInformation.FaxNumber | string |
O número de fax do funcionário secundário. |
|
Endereço de Email
|
SecondaryEmployees.ContactInformation.EmailAddress | string |
O endereço de email do funcionário secundário. |
|
PreferredCommunicationMethod
|
SecondaryEmployees.ContactInformation.PreferredCommunicationMethod | string |
O método de comunicação preferencial dos funcionários secundários. |
|
Site
|
SecondaryEmployees.ContactInformation.Website | string |
O link da Web do funcionário secundário. |
|
ReferenceNumber
|
ReferenceNumber | string |
O número de referência. |
|
RemoteFileNumber
|
RemoteFileNumber | string |
O número do arquivo remoto. |
|
PartnerTypeID
|
PartnerTypeID | integer |
O número de identificação do tipo de parceiro. |
|
ID do Parceiro
|
PartnerID | integer |
O número de identificação do parceiro. |
|
PartnerTypeID
|
PartnerType.PartnerTypeID | integer |
O número de identificação do tipo de parceiro. |
|
PartnerTypeName
|
PartnerType.PartnerTypeName | string |
O nome do tipo de parceiro. |
|
OfficeID
|
OfficeID | integer |
O número de identificação do escritório. |
|
PartnerName
|
PartnerName | string |
O nome do parceiro. |
|
Address1
|
MailingAddress.Address1 | string |
O número e o nome da rua. |
|
Address2
|
MailingAddress.Address2 | string |
Mais informações de endereço. |
|
City
|
MailingAddress.City | string |
O nome da cidade. |
|
Estado
|
MailingAddress.State | string |
A abreviação de estado de duas letras. |
|
Zip
|
MailingAddress.Zip | string |
O CEP. |
|
Número de telefone
|
ContactInformation.PhoneNumber | string |
O número de telefone do parceiro. |
|
HomePhoneNumber
|
ContactInformation.HomePhoneNumber | string |
O número de telefone da casa do parceiro. |
|
CellPhoneNumber
|
ContactInformation.CellPhoneNumber | string |
O número do celular do parceiro. |
|
Caixa postal
|
ContactInformation.Voicemail | string |
O número da caixa postal do parceiro. |
|
FaxNumber
|
ContactInformation.FaxNumber | string |
O número do fax do parceiro. |
|
Endereço de Email
|
ContactInformation.EmailAddress | string |
O endereço de email do parceiro. |
|
PreferredCommunicationMethod
|
ContactInformation.PreferredCommunicationMethod | string |
Os parceiros preferiram a forma de comunicação. |
|
Site
|
ContactInformation.Website | string |
A URL do site do parceiro. |
Cancela pedido feito anteriormente
Cancela um pedido feito anteriormente.
Parâmetros
| Nome | Chave | Obrigatório | Tipo | Description |
|---|---|---|---|---|
|
ID de Arquivo
|
FileID | True | string |
Número de identificação do arquivo. |
|
FileID
|
FileID | integer |
O número de identificação do arquivo. |
Retornos
- response
- object
Carregar documento da URL da Web para um arquivo específico
Carrega o documento da URL da Web no arquivo especificado.
Parâmetros
| Nome | Chave | Obrigatório | Tipo | Description |
|---|---|---|---|---|
|
ID de Arquivo
|
FileID | True | string |
Número de identificação do arquivo. |
|
DocumentName
|
DocumentName | string |
O nome do documento. |
|
|
DocumentTypeID
|
DocumentTypeID | integer |
O número de identificação do tipo de documento. |
|
|
Description
|
Description | string |
A descrição do documento. |
|
|
InternalOnly
|
InternalOnly | boolean |
Se o documento é somente interno ou não. |
|
|
WebURL
|
WebURL | string |
A URL da Web do documento. |
Retornos
| Nome | Caminho | Tipo | Description |
|---|---|---|---|
|
DocumentID
|
Document.DocumentID | integer |
O número de identificação do documento. |
Criar novo arquivo
Cria um arquivo novo.
Parâmetros
| Nome | Chave | Obrigatório | Tipo | Description |
|---|---|---|---|---|
|
Tipo de Entidade
|
EntityType | string |
O nome do tipo de entidade. Individual, corporação, etc. |
|
|
IsPrimaryTransactee
|
IsPrimaryTransactee | boolean |
Se o comprador é ou não o transactee primário. |
|
|
First
|
First | string |
O nome do comprador. |
|
|
Last
|
Last | string |
O sobrenome do comprador. |
|
|
UsePropertyAddress
|
UsePropertyAddress | boolean |
Se o endereço de endereçamento deve ou não ser usado como o endereço de propriedade do novo arquivo. |
|
|
Address1
|
Address1 | string |
O número e o nome da rua. |
|
|
City
|
City | string |
O nome da cidade. |
|
|
Estado
|
State | string |
A abreviação de estado de duas letras. |
|
|
Zip
|
Zip | string |
O CEP. |
|
|
MaritalStatus
|
MaritalStatus | string |
O estado civil do comprador. |
|
|
Email
|
string |
O endereço de email do comprador. |
||
|
Tipo de Entidade
|
EntityType | string |
O nome do tipo de entidade. Individual, corporação, etc. |
|
|
IsPrimaryTransactee
|
IsPrimaryTransactee | boolean |
Se o vendedor é ou não o transactee primário. |
|
|
First
|
First | string |
O nome do vendedor. |
|
|
Last
|
Last | string |
O sobrenome do vendedor. |
|
|
UsePropertyAddress
|
UsePropertyAddress | boolean |
Se o endereço de endereçamento deve ou não ser usado como o endereço de propriedade do novo arquivo. |
|
|
Address1
|
Address1 | string |
O número e o nome da rua. |
|
|
City
|
City | string |
O nome da cidade. |
|
|
Estado
|
State | string |
A abreviação de estado de duas letras. |
|
|
Zip
|
Zip | string |
O CEP. |
|
|
MaritalStatus
|
MaritalStatus | string |
O estado civil do vendedor. |
|
|
Email
|
string |
O endereço de email do vendedor. |
||
|
EstimatedSettlementDate
|
EstimatedSettlementDate | string |
A data de liquidação estimada da ordem. |
|
|
TransactionTypeID
|
TransactionTypeID | integer |
O número de identificação do tipo de transação. |
|
|
ProductTypeID
|
ProductTypeID | integer |
O número de identificação do tipo de produto. |
|
|
SalesPrice
|
SalesPrice | integer |
O preço de venda da propriedade. |
|
|
ClientFileNumber
|
ClientFileNumber | string |
O número do arquivo de clientes. |
|
|
PiggybackFileNumber
|
PiggybackFileNumber | string |
O número do arquivo de piggyback. |
|
|
MainFileNumber
|
MainFileNumber | string |
O número do arquivo principal. |
|
|
SourceOfBusinessID
|
SourceOfBusinessID | integer |
A origem do número de identificação de negócios. |
|
|
Observação
|
Note | string |
Uma anotação a ser adicionada ao novo arquivo. |
|
|
Nome
|
Name | string |
O nome do campo personalizado. |
|
|
Value
|
Value | string |
O valor do campo personalizado |
|
|
LienPosition
|
LienPosition | integer |
A posição lien. |
|
|
LoanNumber
|
LoanNumber | string |
O número do empréstimo. |
|
|
LoanAmount
|
LoanAmount | integer |
O valor do empréstimo. |
|
|
LoanType
|
LoanType | string |
O tipo de empréstimo. |
|
|
IsPrimary
|
IsPrimary | boolean |
Se esse é ou não o endereço da propriedade primária. |
|
|
StreetNumber
|
StreetNumber | string |
O número da rua. |
|
|
StreetName
|
StreetName | string |
O nome da rua. |
|
|
City
|
City | string |
O nome da cidade. |
|
|
Estado
|
State | string |
A abreviação de estado de duas letras. |
|
|
Município
|
County | string |
O condado em que a propriedade está localizada. |
|
|
Zip
|
Zip | string |
O CEP. |
Retornos
| Nome | Caminho | Tipo | Description |
|---|---|---|---|
|
FileID
|
FileID | integer |
O número de identificação do novo arquivo. |
|
FileNumber
|
FileNumber | string |
O número de arquivo do novo arquivo. |
|
Warnings
|
Warnings | array of string |
Avisos relativos ao novo arquivo. |
Criar novo documento em um arquivo específico
Cria um novo documento no arquivo especificado.
Parâmetros
| Nome | Chave | Obrigatório | Tipo | Description |
|---|---|---|---|---|
|
ID de Arquivo
|
FileID | True | string |
Número de identificação do arquivo. |
|
DocumentName
|
DocumentName | string |
O nome do documento. |
|
|
DocumentTypeID
|
DocumentTypeID | integer |
O número de identificação do tipo de documento. |
|
|
Description
|
Description | string |
A descrição do documento. |
|
|
InternalOnly
|
InternalOnly | string |
Se o documento é somente interno ou não. |
|
|
Corpo do Documento
|
DocumentBody | string |
O corpo do documento. |
Retornos
| Nome | Caminho | Tipo | Description |
|---|---|---|---|
|
DocumentID
|
Document.DocumentID | integer |
O número de identificação do documento. |
Estimativa de Taxa de Fechamento
Estima as taxas de fechamento.
Parâmetros
| Nome | Chave | Obrigatório | Tipo | Description |
|---|---|---|---|---|
|
TransactionTypeID
|
TransactionTypeID | integer |
O número de identificação do tipo de transação. |
|
|
ProductTypeID
|
ProductTypeID | integer |
O número de identificação do tipo de produto. |
|
|
SettlementStatementVersion
|
SettlementStatementVersion | string |
A versão da instrução de liquidação. |
|
|
SalesPrice
|
SalesPrice | integer |
O preço de venda. |
|
|
LienPosition
|
LienPosition | integer |
A posição lien. |
|
|
LoanAmount
|
LoanAmount | integer |
O valor do empréstimo. |
|
|
LoanType
|
LoanType | string |
O tipo de empréstimo. |
|
|
IsPrimary
|
IsPrimary | boolean |
Se essa é ou não a propriedade primária. |
|
|
StreetNumber
|
StreetNumber | string |
O número da rua. |
|
|
StreetName
|
StreetName | string |
O nome da rua. |
|
|
City
|
City | string |
O nome da cidade. |
|
|
Estado
|
State | string |
A abreviação de estado de duas letras. |
|
|
Município
|
County | string |
O nome do condado. |
|
|
Zip
|
Zip | string |
O CEP. |
|
|
PartnerTypeID
|
PartnerTypeID | integer |
O número de identificação do tipo de parceiro. |
|
|
ID do Parceiro
|
PartnerID | integer |
O número de identificação do parceiro. |
|
|
PartnerTypeID
|
PartnerTypeID | integer |
O número de identificação do tipo de parceiro. |
|
|
Nome
|
Name | string |
Nome do endosso. |
Retornos
| Nome | Caminho | Tipo | Description |
|---|---|---|---|
|
ClosingFeeEstimateID
|
ClosingFeeEstimate.ClosingFeeEstimateID | integer |
O número de identificação da estimativa de taxa de fechamento. |
|
HUDFees
|
ClosingFeeEstimate.HUDFees | array of object |
As taxas do HUD. |
|
Quantidade
|
ClosingFeeEstimate.HUDFees.Amount | integer |
O valor da taxa do HUD. |
|
Description
|
ClosingFeeEstimate.HUDFees.Description | string |
A descrição da taxa. |
|
LineNumber
|
ClosingFeeEstimate.HUDFees.LineNumber | string |
O número da linha. |
|
BuyerAmount
|
ClosingFeeEstimate.HUDFees.BuyerAmount | integer |
O valor do comprador. |
|
BuyerPOCAmount
|
ClosingFeeEstimate.HUDFees.BuyerPOCAmount | integer |
O valor da POC do comprador. |
|
SellerAmount
|
ClosingFeeEstimate.HUDFees.SellerAmount | integer |
O valor do vendedor. |
|
SellerPOCAmount
|
ClosingFeeEstimate.HUDFees.SellerPOCAmount | integer |
O valor da POC do vendedor. |
|
OtherPOCAmount
|
ClosingFeeEstimate.HUDFees.OtherPOCAmount | integer |
A outra quantidade de POC. |
|
PartnerTypeID
|
ClosingFeeEstimate.HUDFees.OtherPOCPartnerType.PartnerTypeID | integer |
O número de identificação do tipo de parceiro. |
|
PartnerTypeName
|
ClosingFeeEstimate.HUDFees.OtherPOCPartnerType.PartnerTypeName | string |
O nome do tipo de parceiro. |
|
GFE
|
ClosingFeeEstimate.GFE | array of object |
A boa fé estima. |
|
Description
|
ClosingFeeEstimate.GFE.Description | string |
Para que serve a estimativa. |
|
Quantidade
|
ClosingFeeEstimate.GFE.Amount | integer |
A quantidade da estimativa. |
|
LendersPremium
|
ClosingFeeEstimate.Premiums.LendersPremium | integer |
O prêmio dos credores. |
|
FullLendersPremium
|
ClosingFeeEstimate.Premiums.FullLendersPremium | integer |
O prêmio de credores completos. |
|
Timestamp
|
ClosingFeeEstimate.Timestamp | string |
O carimbo de data/hora. |
Excluir parceiro em um arquivo específico
Remove um parceiro do arquivo especificado.
Parâmetros
| Nome | Chave | Obrigatório | Tipo | Description |
|---|---|---|---|---|
|
ID de Arquivo
|
FileID | True | string |
Número de identificação do arquivo. |
|
PartnerTypeID
|
PartnerTypeID | integer |
O número de identificação do tipo de parceiro. |
|
|
ID do Parceiro
|
PartnerID | integer |
O número de identificação do parceiro. |
|
|
PartnerTypeID
|
PartnerTypeID | integer |
O número de identificação do tipo de parceiro. |
Retornos
- response
- object
Excluir pedido feito anteriormente
Cancela um pedido feito anteriormente.
Parâmetros
| Nome | Chave | Obrigatório | Tipo | Description |
|---|---|---|---|---|
|
ID de Arquivo
|
FileID | True | string |
Número de identificação do arquivo. |
|
FileID
|
FileID | integer |
O número de identificação do arquivo. |
Retornos
- response
- object
Obter anotações para um arquivo específico
Obtém uma lista das anotações no arquivo especificado.
Parâmetros
| Nome | Chave | Obrigatório | Tipo | Description |
|---|---|---|---|---|
|
ID de Arquivo
|
FileID | True | string |
Número de identificação do arquivo. |
Retornos
| Nome | Caminho | Tipo | Description |
|---|---|---|---|
|
Anotações
|
Notes | array of object |
A lista de anotações no arquivo. |
|
NoteID
|
Notes.NoteID | integer |
O número de identificação da anotação. |
|
Assunto
|
Notes.Subject | string |
O assunto da anotação. |
|
Corpo
|
Notes.Body | string |
O corpo da anotação. |
|
UserID
|
Notes.CreatedBy.UserID | integer |
O número de identificação do usuário. |
|
Nome
|
Notes.CreatedBy.Name | string |
O nome completo do usuário. |
|
Primeiro Nome
|
Notes.CreatedBy.FirstName | string |
Primeiro nome do usuário. |
|
LastName
|
Notes.CreatedBy.LastName | string |
Sobrenome do usuário. |
|
Número de telefone
|
Notes.CreatedBy.ContactInformation.PhoneNumber | string |
O número de telefone dos usuários. |
|
Endereço de Email
|
Notes.CreatedBy.ContactInformation.EmailAddress | string |
O endereço de email dos usuários. |
|
CreatedDate
|
Notes.CreatedDate | string |
A data em que a anotação foi criada. |
|
FileID
|
Notes.FileID | integer |
O número de identificação do arquivo. |
|
Agilizar
|
Notes.Expedite | boolean |
Se a anotação foi ou não acelerada. |
Obter ações para um arquivo específico
Obtém todas as ações no arquivo especificado.
Parâmetros
| Nome | Chave | Obrigatório | Tipo | Description |
|---|---|---|---|---|
|
ID de Arquivo
|
FileID | True | string |
Número de identificação do arquivo. |
Retornos
| Nome | Caminho | Tipo | Description |
|---|---|---|---|
|
Ações
|
Actions | array of object |
Lista de ações. |
|
FileActionID
|
Actions.FileActionID | integer |
O número de identificação da ação do arquivo. |
|
ActionTypeID
|
Actions.ActionType.ActionTypeID | integer |
O número de identificação do tipo de ação. |
|
Nome
|
Actions.ActionType.Name | string |
O nome da ação. |
|
DisplayName
|
Actions.ActionType.DisplayName | string |
O nome a apresentar. |
|
ActionGroupID
|
Actions.Group.ActionGroupID | integer |
O número de identificação do grupo de ações. |
|
Nome
|
Actions.Group.Name | string |
O nome da ação. |
|
CoordinatorTypeID
|
Actions.StartTask.CoordinatorTypeID | integer |
O número de identificação do tipo coordenador. |
|
Data de Conclusão
|
Actions.StartTask.DueDate | string |
A data de conclusão da ação. |
|
DueDateLocked
|
Actions.StartTask.DueDateLocked | boolean |
se a data de conclusão está bloqueada ou não. |
|
DoneDate
|
Actions.StartTask.DoneDate | string |
A data de conclusão da ação. |
|
DoneDateLocked
|
Actions.StartTask.DoneDateLocked | boolean |
Se a data concluída está bloqueada ou não. |
|
UserID
|
Actions.StartTask.DoneBy.UserID | integer |
O número de identificação do usuário. |
|
Nome
|
Actions.StartTask.DoneBy.Name | string |
O nome do usuário. |
|
CoordinatorTypeID
|
Actions.CompleteTask.CoordinatorTypeID | integer |
O número de identificação do tipo coordenador. |
|
Data de Conclusão
|
Actions.CompleteTask.DueDate | string |
A data de conclusão da ação. |
|
DueDateLocked
|
Actions.CompleteTask.DueDateLocked | boolean |
Se a data de conclusão está bloqueada ou não. |
|
DoneDateLocked
|
Actions.CompleteTask.DoneDateLocked | boolean |
Se a data concluída está bloqueada ou não. |
|
UserID
|
Actions.CompleteTask.DoneBy.UserID | integer |
O número de identificação do usuário. |
|
Nome
|
Actions.CompleteTask.DoneBy.Name | string |
O nome do usuário. |
Obter campos personalizados em um documento específico
Obtenha os campos personalizados no documento especificado.
Parâmetros
| Nome | Chave | Obrigatório | Tipo | Description |
|---|---|---|---|---|
|
ID de Arquivo
|
FileID | True | string |
Número de identificação do arquivo. |
|
ID do documento
|
DocumentID | True | string |
Número de identificação do documento. |
Retornos
| Nome | Caminho | Tipo | Description |
|---|---|---|---|
|
Campos Personalizados
|
CustomFields | array of object |
os campos personalizados. |
|
Nome
|
CustomFields.Name | string |
O nome do campo personalizado. |
|
Value
|
CustomFields.Value | string |
O valor do campo personalizado. |
|
CustomFieldListCount
|
CustomFieldListCount | integer |
O número de campos personalizados no arquivo. |
Obter campos personalizados para um arquivo específico
Obtém os campos personalizados para o arquivo especificado.
Parâmetros
| Nome | Chave | Obrigatório | Tipo | Description |
|---|---|---|---|---|
|
ID de Arquivo
|
FileID | True | string |
Número de identificação do arquivo. |
Retornos
| Nome | Caminho | Tipo | Description |
|---|---|---|---|
|
Campos Personalizados
|
CustomFields | array of object |
Lista de campos personalizados no arquivo. |
|
Nome
|
CustomFields.Name | string |
O nome do campo personalizado. |
|
Value
|
CustomFields.Value | string |
O valor do campo personalizado. |
|
CustomFieldListCount
|
CustomFieldListCount | integer |
o número de campos personalizados no arquivo. |
Obter Documento
Obtém informações sobre um documento com a ID especificada.
Parâmetros
| Nome | Chave | Obrigatório | Tipo | Description |
|---|---|---|---|---|
|
ID do documento
|
DocumentID | True | string |
Número de identificação do documento. |
Retornos
| Nome | Caminho | Tipo | Description |
|---|---|---|---|
|
DocumentID
|
DocumentID | integer |
O número de identificação do documento. |
|
DocumentName
|
DocumentName | string |
O nome do documento. |
|
DocumentTypeID
|
DocumentType.DocumentTypeID | integer |
O nome do tipo de documento. |
|
Nome
|
DocumentType.Name | string |
O nome do tipo de documento. |
|
Description
|
Description | string |
A descrição do documento. |
|
InternalOnly
|
InternalOnly | boolean |
Se o documento é somente interno ou não. |
|
Aprovada
|
Approved | boolean |
Se o documento foi aprovado ou não. |
|
UserID
|
CreateUser.UserID | integer |
O número de identificação do usuário. |
|
CreateDate
|
CreateDate | string |
A data em que o documento foi criado. |
Obter documentos para um arquivo específico
Obtém todas as informações sobre os documentos no arquivo especificado.
Parâmetros
| Nome | Chave | Obrigatório | Tipo | Description |
|---|---|---|---|---|
|
ID de Arquivo
|
FileID | True | string |
Número de identificação do arquivo. |
Retornos
| Nome | Caminho | Tipo | Description |
|---|---|---|---|
|
Documentos
|
Documents | array of object |
Lista de documentos no arquivo. |
|
DocumentID
|
Documents.DocumentID | integer |
O número de identificação do documento. |
|
DocumentName
|
Documents.DocumentName | string |
O nome do documento. |
|
DocumentTypeID
|
Documents.DocumentType.DocumentTypeID | integer |
O número de identificação do tipo de documento. |
|
Nome
|
Documents.DocumentType.Name | string |
O nome do tipo de documento. |
|
Description
|
Documents.Description | string |
A descrição do documento. |
|
InternalOnly
|
Documents.InternalOnly | boolean |
Se o documento é somente interno ou não. |
|
Aprovada
|
Documents.Approved | boolean |
Se o documento foi aprovado ou não. |
|
AssociatedNotes
|
Documents.AssociatedNotes | array of object |
Anotações associadas ao documento. |
|
NoteID
|
Documents.AssociatedNotes.NoteID | integer |
Observe o número de identificação. |
|
UserID
|
Documents.CreateUser.UserID | integer |
O número de identificação do usuário. |
|
Nome
|
Documents.CreateUser.Name | string |
O nome do usuário. |
|
CreateDate
|
Documents.CreateDate | string |
A data em que o documento foi criado. |
|
UserID
|
Documents.ModifyUser.UserID | integer |
O número de identificação do usuário. |
|
Nome
|
Documents.ModifyUser.Name | string |
O nome do usuário. |
|
ModifyDate
|
Documents.ModifyDate | string |
A data em que o documento foi modificado. |
Obter informações do parceiro
Obtém informações sobre um parceiro com a ID especificada.
Parâmetros
| Nome | Chave | Obrigatório | Tipo | Description |
|---|---|---|---|---|
|
ID da Empresa de Parceiros
|
PartnerCompanyID | True | string |
Número de identificação da empresa parceira. |
Retornos
| Nome | Caminho | Tipo | Description |
|---|---|---|---|
|
PartnerCompanyID
|
PartnerCompanyID | integer |
O número de identificação da empresa parceira. |
|
PartnerTypes
|
PartnerTypes | array of object |
Informações sobre o tipo de parceiro. |
|
PartnerTypeID
|
PartnerTypes.PartnerTypeID | integer |
O número de identificação do tipo de parceiro. |
|
PartnerTypeName
|
PartnerTypes.PartnerTypeName | string |
O nome do tipo de parceiro. |
|
OfficeID
|
OfficeID | integer |
O número de identificação do escritório. |
|
PartnerName
|
PartnerName | string |
O nome do parceiro. |
|
CompanyAbbreviation
|
CompanyAbbreviation | string |
A abreviação da empresa. |
|
ProperCompanyName
|
ProperCompanyName | string |
O nome completo da empresa. |
|
Address1
|
MailingAddress.Address1 | string |
O número e o nome da rua. |
|
Address2
|
MailingAddress.Address2 | string |
Mais informações de endereço. |
|
City
|
MailingAddress.City | string |
O nome da cidade. |
|
Estado
|
MailingAddress.State | string |
A abreviação de estado de duas letras. |
|
Zip
|
MailingAddress.Zip | string |
O CEP. |
|
Número de telefone
|
ContactInformation.PhoneNumber | string |
O número de telefone do parceiro. |
|
HomePhoneNumber
|
ContactInformation.HomePhoneNumber | string |
O número de telefone da casa do parceiro. |
|
CellPhoneNumber
|
ContactInformation.CellPhoneNumber | string |
O número do celular do parceiro. |
|
Caixa postal
|
ContactInformation.Voicemail | string |
O número da caixa postal do parceiro. |
|
FaxNumber
|
ContactInformation.FaxNumber | string |
O número do fax do parceiro. |
|
Endereço de Email
|
ContactInformation.EmailAddress | string |
O endereço de email do parceiro. |
|
PreferredCommunicationMethod
|
ContactInformation.PreferredCommunicationMethod | string |
Os parceiros preferiram a forma de comunicação. |
|
Site
|
ContactInformation.Website | string |
A URL do site do parceiro. |
|
ID
|
CompanyInformation.ParentCompany.ID | integer |
O número de identificação. |
|
Nome
|
CompanyInformation.ParentCompany.Name | string |
O nome da empresa pai. |
|
ID
|
CompanyInformation.PartnerEntity.ID | integer |
O número de identificação. |
|
nome
|
CompanyInformation.PartnerEntity.name | string |
O nome da entidade do parceiro. |
|
IsBillable
|
CompanyInformation.IsBillable | boolean |
Se o parceiro pode ou não ser cobrado. |
|
IsInvoiceable
|
CompanyInformation.IsInvoiceable | boolean |
Se a propriedade pode ou não ser faturada. |
|
TaxID
|
CompanyInformation.TaxID | string |
O número de identificação fiscal do parceiro. |
|
AccountingCode
|
CompanyInformation.AccountingCode | string |
O código contábil. |
|
CommentsSpecialInstructions
|
CompanyInformation.CommentsSpecialInstructions | string |
Comentários sobre o parceiro. |
|
DontAllowSelectionInSettlement
|
CompanyInformation.DontAllowSelectionInSettlement | boolean |
Se deseja ou não permitir a seleção na liquidação. |
|
Necessidades1099
|
CompanyInformation.Needs1099 | boolean |
Se um 1099 é ou não necessário. |
|
MWBE
|
CompanyInformation.MWBE | boolean |
Se o parceiro é ou não um MWBE? |
|
SendDocumentsAsWebLinks
|
SendDocumentsAsWebLinks | boolean |
Se deseja ou não enviar os documentos como links da Web. |
|
WireConfirmationEmailTemplateID
|
WireConfirmationEmailTemplateID | integer |
O número de identificação do modelo de confirmação de transmissão. |
|
UseOnDisbursements
|
CourierAddress.UseOnDisbursements | boolean |
Se isso deve ou não ser usado em desembolsos. |
|
Address1
|
CourierAddress.Address1 | string |
O número e o nome da rua. |
|
Address2
|
CourierAddress.Address2 | string |
Mais informações de endereço. |
|
City
|
CourierAddress.City | string |
O nome da cidade. |
|
Estado
|
CourierAddress.State | string |
A abreviação de estado de duas letras. |
|
Zip
|
CourierAddress.Zip | string |
O CEP. |
Obter informações do usuário atual
Obtém as informações sobre o usuário conectado no momento.
Retornos
| Nome | Caminho | Tipo | Description |
|---|---|---|---|
|
Title
|
Title | string |
Título do usuário. |
|
PasswordExpirationDate
|
PasswordExpirationDate | string |
A data em que a senha expirará. |
|
UserID
|
UserID | integer |
O número de identificação do usuário. |
|
Nome
|
Name | string |
O nome do usuário. |
|
Primeiro Nome
|
FirstName | string |
Primeiro nome do usuário. |
|
LastName
|
LastName | string |
Sobrenome do usuário. |
|
CellPhoneNumber
|
ContactInformation.CellPhoneNumber | string |
O número de telefone celular do usuário. |
|
Endereço de Email
|
ContactInformation.EmailAddress | string |
O endereço de email do usuário. |
|
PreferredCommunicationMethod
|
ContactInformation.PreferredCommunicationMethod | string |
O método de comunicação preferencial dos usuários. |
|
Número de telefone
|
ContactInformation.PhoneNumber | string |
O número de telefone do usuário. |
|
FaxNumber
|
ContactInformation.FaxNumber | string |
O número de fax do usuário. |
|
Site
|
ContactInformation.Website | string |
O site do usuário. |
Obter Nota
Obtém a nota com a ID especificada.
Parâmetros
| Nome | Chave | Obrigatório | Tipo | Description |
|---|---|---|---|---|
|
ID da anotação
|
NoteID | True | string |
Observe o número de identificação. |
Retornos
| Nome | Caminho | Tipo | Description |
|---|---|---|---|
|
NoteID
|
NoteID | integer |
O número de identificação da anotação. |
|
Assunto
|
Subject | string |
O assunto da anotação. |
|
Corpo
|
Body | string |
O corpo da anotação. |
|
UserID
|
CreatedBy.UserID | integer |
O número de identificação do usuário. |
|
CreatedDate
|
CreatedDate | string |
A data em que a anotação foi criada. |
|
FileID
|
FileID | integer |
O número de identificação do arquivo. |
Obter parceiros para um arquivo específico
Obtém uma lista de parceiros e suas informações no arquivo especificado.
Parâmetros
| Nome | Chave | Obrigatório | Tipo | Description |
|---|---|---|---|---|
|
ID de Arquivo
|
FileID | True | string |
Número de identificação do arquivo. |
Retornos
| Nome | Caminho | Tipo | Description |
|---|---|---|---|
|
Partners
|
Partners | array of object |
Informações sobre os parceiros. |
|
UserID
|
Partners.PrimaryEmployee.UserID | integer |
O número de identificação do usuário. |
|
Nome
|
Partners.PrimaryEmployee.Name | string |
O nome completo do funcionário. |
|
Primeiro Nome
|
Partners.PrimaryEmployee.FirstName | string |
O nome do funcionário. |
|
LastName
|
Partners.PrimaryEmployee.LastName | string |
O sobrenome do funcionário. |
|
Número de telefone
|
Partners.PrimaryEmployee.ContactInformation.PhoneNumber | string |
O número de telefone do funcionário. |
|
Endereço de Email
|
Partners.PrimaryEmployee.ContactInformation.EmailAddress | string |
O endereço de email do funcionário. |
|
PartnerTypeID
|
Partners.PartnerTypeID | integer |
O número de identificação do tipo de parceiro. |
|
ID do Parceiro
|
Partners.PartnerID | integer |
O número de identificação do parceiro. |
|
PartnerTypeID
|
Partners.PartnerType.PartnerTypeID | integer |
O número de identificação do tipo de parceiro. |
|
PartnerTypeName
|
Partners.PartnerType.PartnerTypeName | string |
O nome do tipo de parceiro. |
|
PartnerName
|
Partners.PartnerName | string |
O nome do parceiro. |
Obter partes para um arquivo específico
Obtém uma lista das partes e suas informações no arquivo especificado.
Parâmetros
| Nome | Chave | Obrigatório | Tipo | Description |
|---|---|---|---|---|
|
ID de Arquivo
|
FileID | True | string |
Número de identificação do arquivo. |
Retornos
| Nome | Caminho | Tipo | Description |
|---|---|---|---|
|
Compradores
|
Buyers | array of object |
Informações sobre os compradores. |
|
LegalEntityID
|
Buyers.LegalEntityID | integer |
O número de identificação da entidade legal. |
|
Tipo de Entidade
|
Buyers.EntityType | string |
O nome do tipo de entidade. |
|
Prefixo
|
Buyers.Primary.Prefix | string |
Prefixo do comprador. |
|
First
|
Buyers.Primary.First | string |
Nome do comprador. |
|
Meio
|
Buyers.Primary.Middle | string |
Nome do meio do comprador. |
|
Last
|
Buyers.Primary.Last | string |
Sobrenome do comprador. |
|
Sufixo
|
Buyers.Primary.Suffix | string |
Sufixo do comprador. |
|
Prefixo
|
Buyers.Secondary.Prefix | string |
Prefixo do comprador secundário. |
|
First
|
Buyers.Secondary.First | string |
Nome do comprador secundário. |
|
Meio
|
Buyers.Secondary.Middle | string |
Nome do meio do comprador secundário. |
|
Last
|
Buyers.Secondary.Last | string |
Sobrenome do comprador secundário. |
|
UsePropertyAddress
|
Buyers.UsePropertyAddress | boolean |
Se deve ou não usar o endereço. |
|
Address1
|
Buyers.Address.Address1 | string |
O número e o nome da rua. |
|
City
|
Buyers.Address.City | string |
O nome da cidade. |
|
Estado
|
Buyers.Address.State | string |
A abreviação de estado de duas letras. |
|
Zip
|
Buyers.Address.Zip | string |
O CEP. |
|
MaritalStatus
|
Buyers.MaritalStatus | string |
O estado civil da festa. |
|
Email
|
Buyers.Email | string |
O endereço de email da parte. |
|
HomePhone
|
Buyers.HomePhone | string |
O número de telefone da festa. |
|
EmailSecondary
|
Buyers.EmailSecondary | string |
O endereço de email da parte secundária. |
|
Vendedores
|
Sellers | array of object |
Informações sobre os vendedores. |
|
LegalEntityID
|
Sellers.LegalEntityID | integer |
O número de identificação da entidade legal. |
|
Tipo de Entidade
|
Sellers.EntityType | string |
O tipo de entidade. |
|
BusinessName
|
Sellers.Primary.BusinessName | string |
O nome do negócio. |
|
UsePropertyAddress
|
Sellers.UsePropertyAddress | boolean |
Se deve ou não usar o endereço. |
|
Address1
|
Sellers.Address.Address1 | string |
O número e o nome da rua. |
|
City
|
Sellers.Address.City | string |
O nome da cidade. |
|
Estado
|
Sellers.Address.State | string |
A abreviação de estado de duas letras. |
|
Zip
|
Sellers.Address.Zip | string |
O CEP. |
|
MaritalStatus
|
Sellers.MaritalStatus | string |
O estado civil da festa. |
|
Email
|
Sellers.Email | string |
O endereço de email da parte. |
|
Clientes
|
Customers | array of string |
Informações sobre os clientes. |
Obter PDF do Recibo de Estimativa de Taxa de Fechamento
Obtém o recibo de estimativa de taxa de fechamento no formato pdf.
Parâmetros
| Nome | Chave | Obrigatório | Tipo | Description |
|---|---|---|---|---|
|
ID da taxa de fechamento
|
ClosingFeeID | True | string |
Número de identificação da taxa de fechamento. |
Retornos
- response
- object
Obter recibo de estimativa de taxa de fechamento
Obtém o recibo de estimativa de taxa de fechamento.
Parâmetros
| Nome | Chave | Obrigatório | Tipo | Description |
|---|---|---|---|---|
|
ID da taxa de fechamento
|
ClosingFeeID | True | string |
Número de identificação da taxa de fechamento. |
Retornos
| Nome | Caminho | Tipo | Description |
|---|---|---|---|
|
EstimateDate
|
EstimateDate | string |
A data da estimativa. |
|
TransactionTypeID
|
Request.TransactionProductType.TransactionTypeID | integer |
O número de identificação do tipo de transação. |
|
ProductTypeID
|
Request.TransactionProductType.ProductTypeID | integer |
O número de identificação do tipo de produto. |
|
SettlementStatementVersion
|
Request.SettlementStatementVersion | string |
A versão da instrução de liquidação. |
|
SalesPrice
|
Request.SalesPrice | integer |
O preço de venda. |
|
Empréstimos
|
Request.Loans | array of object |
Informações sobre os empréstimos. |
|
LienPosition
|
Request.Loans.LienPosition | integer |
A posição lien. |
|
LoanAmount
|
Request.Loans.LoanAmount | integer |
O valor do empréstimo. |
|
LoanType
|
Request.Loans.LoanType | string |
O tipo de empréstimo. |
|
Propriedades
|
Request.Properties | array of object |
Propriedades na estimativa. |
|
IsPrimary
|
Request.Properties.IsPrimary | boolean |
Se essa é ou não a propriedade primária. |
|
StreetNumber
|
Request.Properties.StreetNumber | string |
O número da rua. |
|
StreetName
|
Request.Properties.StreetName | string |
O nome da rua. |
|
City
|
Request.Properties.City | string |
O nome da cidade. |
|
Estado
|
Request.Properties.State | string |
A abreviação de estado de duas letras. |
|
Município
|
Request.Properties.County | string |
O nome do condado. |
|
Zip
|
Request.Properties.Zip | string |
O CEP. |
|
FilePartners
|
Request.FilePartners | array of object |
Parceiros no arquivo. |
|
PartnerTypeID
|
Request.FilePartners.PartnerTypeID | integer |
O número de identificação do tipo de parceiro. |
|
ID do Parceiro
|
Request.FilePartners.PartnerID | integer |
O número de identificação do parceiro. |
|
PartnerTypeID
|
Request.FilePartners.PartnerType.PartnerTypeID | integer |
O número de identificação do tipo de parceiro. |
|
Endossos
|
Request.Endorsements | array of object |
Os endossamentos. |
|
Nome
|
Request.Endorsements.Name | string |
Nome do endosso. |
|
ClosingFeeEstimateID
|
Response.ClosingFeeEstimateID | integer |
O número de identificação da estimativa de taxa de fechamento. |
|
HUDFees
|
Response.HUDFees | array of object |
As taxas do HUD. |
|
Quantidade
|
Response.HUDFees.Amount | integer |
O valor da taxa do HUD. |
|
Description
|
Response.HUDFees.Description | string |
A descrição da taxa. |
|
LineNumber
|
Response.HUDFees.LineNumber | string |
O número da linha. |
|
BuyerAmount
|
Response.HUDFees.BuyerAmount | integer |
O valor do comprador. |
|
BuyerPOCAmount
|
Response.HUDFees.BuyerPOCAmount | integer |
O valor da POC do comprador. |
|
SellerAmount
|
Response.HUDFees.SellerAmount | integer |
O valor do vendedor. |
|
SellerPOCAmount
|
Response.HUDFees.SellerPOCAmount | integer |
O valor da POC do vendedor. |
|
OtherPOCAmount
|
Response.HUDFees.OtherPOCAmount | integer |
A outra quantidade de POC. |
|
PartnerTypeID
|
Response.HUDFees.OtherPOCPartnerType.PartnerTypeID | integer |
O número de identificação do tipo de parceiro. |
|
PartnerTypeName
|
Response.HUDFees.OtherPOCPartnerType.PartnerTypeName | string |
O nome do tipo de parceiro. |
|
GFE
|
Response.GFE | array of object |
A boa fé estima. |
|
Description
|
Response.GFE.Description | string |
Para que serve a estimativa. |
|
Quantidade
|
Response.GFE.Amount | integer |
A quantidade da estimativa. |
|
LendersPremium
|
Response.Premiums.LendersPremium | integer |
O prêmio dos credores. |
|
FullLendersPremium
|
Response.Premiums.FullLendersPremium | integer |
O prêmio de credores completos. |
|
Timestamp
|
Response.Timestamp | string |
O carimbo de data/hora. |
Obter tipos de transação e produto para estimativa e posicionamento de pedidos
Obtenha tipos de transação e tipos de produto para estimativa de taxa e fazer pedidos.
Parâmetros
| Nome | Chave | Obrigatório | Tipo | Description |
|---|---|---|---|---|
|
Estado
|
State | string |
Estado do local estimado da propriedade. |
|
|
Município
|
County | string |
Condado de local estimado da propriedade. |
Retornos
| Nome | Caminho | Tipo | Description |
|---|---|---|---|
|
|
array of object | ||
|
TransactionType
|
TransactionType | string |
O tipo de transação. |
|
TransactionTypeID
|
TransactionTypeID | integer |
O número de identificação do tipo de transação. |
|
ProductType
|
ProductType | string |
O tipo de produto. |
|
ProductTypeID
|
ProductTypeID | integer |
O número de identificação do tipo de produto. |
|
AncillaryProducts
|
AncillaryProducts | array of object |
Os produtos auxiliares. |
|
Nome
|
AncillaryProducts.Name | string |
O nome do produto auxiliar. |
|
ID
|
AncillaryProducts.ID | integer |
O número de identificação do produto. |
|
Opções
|
AncillaryProducts.Options | array of object |
As opções. |
|
ID
|
AncillaryProducts.Options.ID | integer |
O número de identificação da opção. |
|
Nome
|
AncillaryProducts.Options.Name | string |
O nome da opção. |
|
AddOnProducts
|
AddOnProducts | array of object |
O adicionado em produtos. |
|
TransactionType
|
AddOnProducts.TransactionType | string |
O tipo de transação. |
|
TransactionTypeID
|
AddOnProducts.TransactionTypeID | integer |
O número de identificação do tipo de transação. |
|
ProductType
|
AddOnProducts.ProductType | string |
O tipo de produto. |
|
ProductTypeID
|
AddOnProducts.ProductTypeID | integer |
O número de identificação do tipo de produto. |
Obtém arquivos de determinados critérios de pesquisa
Obtém uma lista de arquivos e suas informações com base nos critérios de pesquisa especificados.
Parâmetros
| Nome | Chave | Obrigatório | Tipo | Description |
|---|---|---|---|---|
|
FileNumber
|
FileNumber | string |
O número do arquivo. |
|
|
FileID
|
FileID | integer |
O número de identificação do arquivo. |
|
|
OfficeID
|
OfficeID | integer |
O número de identificação do escritório. |
|
|
ClientsFileNumber
|
ClientsFileNumber | string |
O número do arquivo de clientes. |
|
|
TransactionTypeID
|
TransactionTypeID | integer |
O número de identificação do tipo de transação. |
|
|
ProductTypeID
|
ProductTypeID | integer |
O número de identificação do tipo de produto. |
|
|
StatusID
|
StatusID | integer |
O número de identificação do status. |
|
|
Nome
|
Name | string |
O nome do status. |
|
|
PolicyNumber
|
PolicyNumber | string |
O número da política. |
|
|
SearchNumber
|
SearchNumber | string |
O número da pesquisa. |
|
|
LoanNumber
|
LoanNumber | string |
O número do empréstimo. |
|
|
IsPrimary
|
IsPrimary | boolean |
Se esse é ou não o endereço da propriedade primária. |
|
|
StreetNumber
|
StreetNumber | string |
O número da rua. |
|
|
StreetName
|
StreetName | string |
O nome da rua. |
|
|
City
|
City | string |
O nome da cidade. |
|
|
Estado
|
State | string |
A abreviação de estado de duas letras. |
|
|
Zip
|
Zip | string |
O CEP. |
|
|
Subdivisão
|
Subdivision | string |
A subdivisão em que a propriedade está localizada. |
|
|
ParcelID
|
ParcelID | string |
O número de identificação da parcela. |
|
|
Tipo de Entidade
|
EntityType | string |
O tipo de entidade. |
|
|
First
|
First | string |
O primeiro nome da festa. |
|
|
Last
|
Last | string |
O sobrenome da festa. |
|
|
UsePropertyAddress
|
UsePropertyAddress | boolean |
Se esse é ou não o endereço da propriedade primária. |
|
|
MaritalStatus
|
MaritalStatus | string |
O estado civil da festa. |
|
|
UserID
|
UserID | integer |
O número de identificação do usuário. |
|
|
PartnerTypeID
|
PartnerTypeID | integer |
O número de identificação do tipo de parceiro. |
|
|
ID do Parceiro
|
PartnerID | integer |
O número de identificação do parceiro. |
|
|
PartnerTypeID
|
PartnerTypeID | integer |
O número de identificação do tipo de parceiro. |
|
|
OpenedFromDate
|
OpenedFromDate | string |
A data em que o arquivo foi aberto. |
|
|
OpenedToDate
|
OpenedToDate | string |
A data em que o arquivo foi fechado. |
Retornos
- response
- object
Definições
objeto
Esse é o tipo 'object'.