Partilhar via

InfoQuery

O InfoQuery permite que você automatize seus negócios aproveitando seus dados Resware em uma solução low-code. Pode visualizar, criar, eliminar e atualizar ficheiros, documentos, parceiros, etc.

Este conector está disponível nos seguintes produtos e regiões:

Serviço Class Regiões
Estúdio Copiloto Premium Todas as regiões do Power Automatic , exceto as seguintes:
     - Governo dos EUA (CCG)
     - Governo dos EUA (GCC High)
     - China Cloud operado pela 21Vianet
     - Departamento de Defesa dos EUA (DoD)
Aplicações Lógicas Standard Todas as regiões do Logic Apps , exceto as seguintes:
     - Regiões do Azure Government
     - Regiões do Azure China
     - Departamento de Defesa dos EUA (DoD)
Aplicações Power Premium Todas as regiões do Power Apps , exceto as seguintes:
     - Governo dos EUA (CCG)
     - Governo dos EUA (GCC High)
     - China Cloud operado pela 21Vianet
     - Departamento de Defesa dos EUA (DoD)
Automatize o poder Premium Todas as regiões do Power Automatic , exceto as seguintes:
     - Governo dos EUA (CCG)
     - 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/
Email support@infoquery.pro
Metadados do conector
Editora InfoQuery LLC
Sítio Web https://infoquery.pro/
Política de privacidade https://infoquery.pro/privacy/
Categorias Conteúdos e Ficheiros; Dados

O InfoQuery Title Explorer permite automatizar as alterações no seu sistema Resware. Você terá a capacidade de adicionar, excluir ou editar arquivos, ações, notas, documentos, etc.

Pré-requisitos

  • A chave API é necessária, deve se inscrever em https://connector.infoquery.pro/
  • Uma conta Resware também é necessária. Nome de usuário, senha e URL do portal serão necessários para formar a conexão.

Como obter credenciais

Introdução ao conector

  • Vá para Power Automate em https://powerautomate.microsoft.com.
  • Crie um novo fluxo ou edite um fluxo existente.
  • Adicione uma nova etapa ao fluxo, procure InfoQuery Title Explorer para ver todas as ações disponíveis.
  • Depois de selecionar a ação, você precisará criar uma nova conexão.
  • Digite o nome da conexão, a chave da API, o nome de usuário do Resware, a senha e a URL do portal. O URL do portal deve estar no formato de https://portal.infoquery.com/API.
  • Contacte support@infoquery.pro ou visite https://infoquery.pro/support/ se for necessária assistência.

Problemas conhecidos e limitações

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, certas ações podem exigir o fornecimento de informações específicas para que o conector funcione corretamente. Será necessário conhecimento do seu sistema Resware.

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 será 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 sucesso para a Resware, dando a resposta 200, mas as ações podem não ter ocorrido conforme o esperado. Seu administrador ou portal do Resware poderá fornecer as informações necessárias para concluir as ações.

FAQ

  1. Onde posso encontrar o URL do meu portal Resware?

    O administrador do Resware fornecerá o URL do portal.

  2. Como faço 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.

A criar uma ligação

O conector suporta os seguintes tipos de autenticação:
Predefinição 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.

Esta conexão não é compartilhável. Se o aplicativo avançado 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 (de caracteres) O nome de usuário para ResWare Verdade
Senha do ResWare securestring A senha do ResWare Verdade
ResWare Portal URL cadeia (de caracteres) A url do portal para ResWare Verdade

Limites de Limitação

Name Chamadas Período de Renovação
Chamadas de API por conexão 100 60 segundos

Ações

Adicionar ação ao arquivo

Adiciona uma ação ao arquivo especificado.
Adicionar nota ao ficheiro

Adiciona uma nova nota ao arquivo especificado.
Adicionar novo funcionário parceiro à empresa parceira

Adiciona um novo funcionário parceiro a uma empresa parceira.
Adicionar ou atualizar campo personalizado em arquivo específico

Adiciona ou atualiza campos personalizados no arquivo especificado.
Adicionar ou atualizar campo personalizado em documento específico

Adiciona ou atualiza campos personalizados no documento especificado no arquivo especificado.
Adicionar parceiro a arquivo específico

Adiciona um parceiro ao arquivo especificado.
Atualizar funcionário do parceiro

Atualiza as informações de um funcionário parceiro.
Atualizar informações do parceiro para arquivo específico

Atualiza as informações do parceiro no arquivo especificado.
Ação de atualização para arquivo

Atualiza uma ação para um determinado arquivo. Pode atualizar o ID do Grupo de Ação e iniciar/concluir o ID do Tipo de Coordenador, o ID do Tipo de Parceiro, a Data de Conclusão, a Data de Conclusão Bloqueada e a Data de Conclusão Bloqueada. Esta chamada de API não pode ser usada para marcar uma ação como iniciada ou concluída.
Cancela Encomenda Feita Anteriormente

Cancela um pedido feito anteriormente.
Carregar documento de URL da Web para arquivo específico

Carrega o documento de URL da Web no arquivo especificado.
Criar novo arquivo

Cria um novo arquivo.
Criar novo documento em arquivo específico

Cria um novo documento no arquivo especificado.
Estimativa de Taxa de Fechamento

Estima as taxas de fechamento.
Excluir parceiro em arquivo específico

Remove um parceiro do arquivo especificado.
Excluir pedido feito anteriormente

Cancela um pedido feito anteriormente.
Obter anotações para arquivo específico

Obtém uma lista das notas no arquivo especificado.
Obter ações para arquivo específico

Obtém todas as ações no arquivo especificado.
Obter campos personalizados em documentos específicos

Obtenha os campos personalizados no documento especificado.
Obter campos personalizados para 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 arquivo específico

Obtém todas as informações sobre os documentos no arquivo especificado.
Obter informações atuais do usuário

Obtém as informações sobre o usuário conectado no momento.
Obter informações de parceiros

Obtém informações sobre um parceiro com a ID especificada.
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 arquivo específico

Obtém uma lista das partes e suas informações no arquivo especificado.
Obter PDF de Recibo de Estimativa de Taxa de Fechamento

Obtém o recibo da estimativa da taxa de fechamento no formato pdf.
Obter recibo de estimativa de taxa de fechamento

Obtém o recibo da estimativa da taxa de fechamento.
Obter transações e tipos de produtos para estimativa e colocação de pedidos

Obtenha tipos de transação e tipos de produtos para estimativa de taxas e colocação de 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 fornecidos.

Adicionar ação ao arquivo

ID da Operação:
AddActionToFile

Adiciona uma ação ao arquivo especificado.

Parâmetros

Name Chave Necessário Tipo Description
ID do ficheiro
 FileID True string

Número de identificação do ficheiro.
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ção.
CoordinatorTypeID
 CoordinatorTypeID integer

O número de identificação do tipo coordenador.
Data de vencimento
 DueDate string

A data de vencimento da ação.
PartnerTypeID
 PartnerTypeID integer

O número de identificação do tipo de parceiro.
Data de vencimento
 DueDate string

A data de vencimento da ação.

Devoluções

Name Caminho Tipo Description
FileActionID
 FileActionID integer

O número de identificação da ação do arquivo.

Adicionar nota ao ficheiro

ID da Operação:
AddNoteToFile

Adiciona uma nova nota ao arquivo especificado.

Parâmetros

Name Chave Necessário Tipo Description
ID do ficheiro
 FileID True string

Número de identificação do ficheiro.
Assunto
 Subject string

O assunto da nota.
Body
 Body string

O corpo da nota.

Devoluções

Name Caminho Tipo Description
ObservaçãoID
 note.NoteID integer

O número de identificação da nota.

Adicionar novo funcionário parceiro à empresa parceira

ID da Operação:
AddNewPartnerEmployeeToPartnerCompany

Adiciona um novo funcionário parceiro a uma empresa parceira.

Parâmetros

Name Chave Necessário Tipo Description
ID da Empresa Parceira
 PartnerCompanyID True string

Número de identificação da empresa parceira.
Palavra-passe
 Password string

Senha para o novo funcionário.
PasswordExpirationDate
 PasswordExpirationDate string

A data em que a senha expirará.
Ativado(a)
 Enabled boolean

Se o novo funcionário será habilitado ou não para uso.
Acesso ao site
 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 primeiro nome do novo funcionário.
Apelido
 LastName string

O sobrenome do novo funcionário.
Endereço de Email
 EmailAddress string

O endereço de e-mail do novo funcionário.

Devoluções

Name Caminho Tipo Description
ID da EmpresaParceira
 Employee.PartnerCompanyID integer

O número de identificação da empresa parceira.
Ativado(a)
 Employee.Enabled boolean

Se o novo funcionário foi habilitado ou não para uso.
Acesso ao site
 Employee.WebsiteAccess boolean

Se o funcionário tem ou não acesso ao site.
ID de utilizador
 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 primeiro nome do funcionário.
Apelido
 Employee.LastName string

O sobrenome do funcionário.
Endereço de Email
 Employee.ContactInformation.EmailAddress string

O endereço de e-mail do funcionário.

Adicionar ou atualizar campo personalizado em arquivo específico

ID da Operação:
AddOrUpdateCustomFieldOnSpecificFile

Adiciona ou atualiza campos personalizados no arquivo especificado.

Parâmetros

Name Chave Necessário Tipo Description
ID do ficheiro
 FileID True string

Número de identificação do ficheiro.
Nome
 Name string

O nome do campo personalizado.
Valor
 Value string

O valor do campo personalizado.

Devoluções

response
object

Adicionar ou atualizar campo personalizado em documento específico

ID da Operação:
AddOrUpdateCustomFieldOnSpecificDocument

Adiciona ou atualiza campos personalizados no documento especificado no arquivo especificado.

Parâmetros

Name Chave Necessário Tipo Description
ID do ficheiro
 FileID True string

Número de identificação do ficheiro.
ID do documento
 DocumentID True string

Número de identificação do documento.
Nome
 Name string

O nome do campo personalizado.
Valor
 Value string

O valor do campo personalizado.

Devoluções

response
object

Adicionar parceiro a arquivo específico

ID da Operação:
AddPartnerToSpecificFile

Adiciona um parceiro ao arquivo especificado.

Parâmetros

Name Chave Necessário Tipo Description
ID do ficheiro
 FileID True string

Número de identificação do ficheiro.
ID de utilizador
 UserID integer

O número de identificação do utilizador.
ID de utilizador
 UserID integer

O número de identificação do utilizador.
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.

Devoluções

response
object

Atualizar funcionário do parceiro

ID da Operação:
UpdatePartnerEmployee

Atualiza as informações de um funcionário parceiro.

Parâmetros

Name Chave Necessário Tipo Description
ID de utilizador
 UserID True string

Número de identificação do utilizador.
ID da Empresa Parceira
 PartnerCompanyID True string

Número de identificação da empresa parceira.
Palavra-passe
 Password string

A senha dos funcionários.
PasswordExpirationDate
 PasswordExpirationDate string

A data em que a senha expirará.
ID da Função
 RoleID integer

O número de identificação da função.
Nome
 Name string

O nome da função.
Ativado(a)
 Enabled boolean

Se o funcionário foi habilitado ou não para uso.
Acesso ao site
 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 primeiro nome do funcionário.
Apelido
 LastName string

O sobrenome do funcionário.
Endereço de Email
 EmailAddress string

O endereço de e-mail do funcionário.

Devoluções

Name Caminho Tipo Description
ID da EmpresaParceira
 Employee.PartnerCompanyID integer

O número de identificação da empresa parceira.
Funções
 Employee.Roles array of object

Funções do funcionário.
ID da Função
 Employee.Roles.RoleID integer

O número de identificação da função.
Nome
 Employee.Roles.Name string

O nome da função.
Ativado(a)
 Employee.Enabled boolean

Se o funcionário foi habilitado ou não para uso.
Acesso ao site
 Employee.WebsiteAccess boolean

Se o funcionário tem ou não acesso ao site.
ID de utilizador
 Employee.UserID integer

O número de identificação do utilizador.
Nome
 Employee.Name string

O nome completo do funcionário.
Primeiro Nome
 Employee.FirstName string

O primeiro nome do funcionário.
Apelido
 Employee.LastName string

O sobrenome do funcionário.
Endereço de Email
 Employee.ContactInformation.EmailAddress string

O endereço de e-mail do funcionário.

Atualizar informações do parceiro para arquivo específico

ID da Operação:
UpdatePartnerInformationForSpecificFile

Atualiza as informações do parceiro no arquivo especificado.

Parâmetros

Name Chave Necessário Tipo Description
ID do ficheiro
 FileID True string

Número de identificação do ficheiro.
ID de Parceiro
 PartnerID True string

Número de identificação do parceiro.
ID do ficheiro
 FileID integer

O número de identificação do ficheiro.
ID de utilizador
 UserID integer

O número de identificação do utilizador.
Nome
 Name string

O nome completo do funcionário.
Primeiro Nome
 FirstName string

O primeiro nome do funcionário.
Apelido
 LastName string

O sobrenome do funcionário.
Número de telefone
 PhoneNumber string

O número de telefone do funcionário.
HomeTelefoneNúmero
 HomePhoneNumber string

O número de telefone residencial do funcionário.
Número de Telemóvel
 CellPhoneNumber string

O número de telefone celular do funcionário.
Voicemail
 Voicemail string

O correio de voz do funcionário.
Número de fax
 FaxNumber string

O número de fax do funcionário.
Endereço de Email
 EmailAddress string

O endereço de e-mail do funcionário.
PreferredCommunicationMethod
 PreferredCommunicationMethod string

Os colaboradores preferiram o método de comunicação.
Sítio Web
 Website string

O link da web do funcionário.
ID de utilizador
 UserID integer

O número de identificação do utilizador.
Nome
 Name string

O nome completo do funcionário secundário.
Primeiro Nome
 FirstName string

O primeiro nome do funcionário secundário.
Apelido
 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.
HomeTelefoneNúmero
 HomePhoneNumber string

O número de telefone residencial do funcionário secundário.
Número de Telemóvel
 CellPhoneNumber string

O número de telefone celular do funcionário secundário.
Voicemail
 Voicemail string

O correio de voz do funcionário secundário.
Número de fax
 FaxNumber string

O número de fax do funcionário secundário.
Endereço de Email
 EmailAddress string

O endereço de e-mail do funcionário secundário.
PreferredCommunicationMethod
 PreferredCommunicationMethod string

Os funcionários secundários preferiram o método de comunicação.
Sítio Web
 Website string

O link da web do funcionário secundário.
Número de referência
 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.
Nome_do_parceiro
 PartnerTypeName string

O nome do tipo de parceiro.
ID do escritório
 OfficeID integer

O número de identificação do escritório.
Nome do parceiro
 PartnerName string

O nome do parceiro.
Endereço1
 Address1 string

O número e o nome da rua.
Endereço2
 Address2 string

Mais informações sobre endereços.
City
 City string

O nome da cidade.
Estado
 State string

As duas letras indicam a abreviatura.
Código Postal
 Zip string

O código postal.
Número de telefone
 PhoneNumber string

O número de telefone do parceiro.
HomeTelefoneNúmero
 HomePhoneNumber string

O número de telefone residencial do parceiro.
Número de Telemóvel
 CellPhoneNumber string

O número de telemóvel do parceiro.
Voicemail
 Voicemail string

O número da caixa postal do parceiro.
Número de fax
 FaxNumber string

O número de fax do parceiro.
Endereço de Email
 EmailAddress string

O endereço de e-mail do parceiro.
PreferredCommunicationMethod
 PreferredCommunicationMethod string

Os parceiros preferiram a forma de comunicação.
Sítio Web
 Website string

O URL do site parceiro.

Devoluções

Name Caminho Tipo Description
ID do ficheiro
 FileID integer

O número de identificação do ficheiro.
Número do arquivo
 FileNumber string

O número do ficheiro
ID de utilizador
 PrimaryEmployee.UserID integer

O número de identificação do utilizador.
Nome
 PrimaryEmployee.Name string

O nome completo do funcionário.
Primeiro Nome
 PrimaryEmployee.FirstName string

O primeiro nome do funcionário.
Apelido
 PrimaryEmployee.LastName string

O sobrenome do funcionário.
Número de telefone
 PrimaryEmployee.ContactInformation.PhoneNumber string

O número de telefone do funcionário.
HomeTelefoneNúmero
 PrimaryEmployee.ContactInformation.HomePhoneNumber string

O número de telefone residencial do funcionário.
Número de Telemóvel
 PrimaryEmployee.ContactInformation.CellPhoneNumber string

O número de telefone celular do funcionário.
Voicemail
 PrimaryEmployee.ContactInformation.Voicemail string

O correio de voz do funcionário.
Número de fax
 PrimaryEmployee.ContactInformation.FaxNumber string

O número de fax do funcionário.
Endereço de Email
 PrimaryEmployee.ContactInformation.EmailAddress string

O endereço de e-mail do funcionário.
PreferredCommunicationMethod
 PrimaryEmployee.ContactInformation.PreferredCommunicationMethod string

Os colaboradores preferiram o método de comunicação.
Sítio Web
 PrimaryEmployee.ContactInformation.Website string

O link da web do funcionário.
SecundáriosFuncionários
 SecondaryEmployees array of object

Informações relativas ao trabalhador secundário.
ID de utilizador
 SecondaryEmployees.UserID integer

O número de identificação do utilizador.
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.
Apelido
 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.
HomeTelefoneNúmero
 SecondaryEmployees.ContactInformation.HomePhoneNumber string

O número de telefone residencial do funcionário secundário.
Número de Telemóvel
 SecondaryEmployees.ContactInformation.CellPhoneNumber string

O número de telefone celular do funcionário secundário.
Voicemail
 SecondaryEmployees.ContactInformation.Voicemail string

O correio de voz do funcionário secundário.
Número de fax
 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 e-mail do funcionário secundário.
PreferredCommunicationMethod
 SecondaryEmployees.ContactInformation.PreferredCommunicationMethod string

Os funcionários secundários preferiram o método de comunicação.
Sítio Web
 SecondaryEmployees.ContactInformation.Website string

O link da web do funcionário secundário.
Número de referência
 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.
Nome_do_parceiro
 PartnerType.PartnerTypeName string

O nome do tipo de parceiro.
ID do escritório
 OfficeID integer

O número de identificação do escritório.
Nome do parceiro
 PartnerName string

O nome do parceiro.
Endereço1
 MailingAddress.Address1 string

O número e o nome da rua.
Endereço2
 MailingAddress.Address2 string

Mais informações sobre endereços.
City
 MailingAddress.City string

O nome da cidade.
Estado
 MailingAddress.State string

As duas letras indicam a abreviatura.
Código Postal
 MailingAddress.Zip string

O código postal.
Número de telefone
 ContactInformation.PhoneNumber string

O número de telefone do parceiro.
HomeTelefoneNúmero
 ContactInformation.HomePhoneNumber string

O número de telefone residencial do parceiro.
Número de Telemóvel
 ContactInformation.CellPhoneNumber string

O número de telemóvel do parceiro.
Voicemail
 ContactInformation.Voicemail string

O número da caixa postal do parceiro.
Número de fax
 ContactInformation.FaxNumber string

O número de fax do parceiro.
Endereço de Email
 ContactInformation.EmailAddress string

O endereço de e-mail do parceiro.
PreferredCommunicationMethod
 ContactInformation.PreferredCommunicationMethod string

Os parceiros preferiram a forma de comunicação.
Sítio Web
 ContactInformation.Website string

O URL do site parceiro.

Ação de atualização para arquivo

ID da Operação:
UpdateActionForFile

Atualiza uma ação para um determinado arquivo. Pode atualizar o ID do Grupo de Ação e iniciar/concluir o ID do Tipo de Coordenador, o ID do Tipo de Parceiro, a Data de Conclusão, a Data de Conclusão Bloqueada e a Data de Conclusão Bloqueada. Esta chamada de API não pode ser usada para marcar uma ação como iniciada ou concluída.

Parâmetros

Name Chave Necessário Tipo Description
ID do ficheiro
 FileID True string

Número de identificação do ficheiro.
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 vencimento
 DueDate string

A data de vencimento da ação.
DoneDateLocked
 DoneDateLocked boolean

Se a data de conclusão está bloqueada ou não.
CoordinatorTypeID
 CoordinatorTypeID integer

O número de identificação do tipo coordenador.
Data de vencimento
 DueDate string

A data de vencimento da ação.
DoneDateLocked
 DoneDateLocked boolean

Se a data de conclusão está bloqueada ou não.

Devoluções

Name Caminho Tipo Description
FileActionID
 FileActionID integer

O número de identificação da ação.

Cancela Encomenda Feita Anteriormente

ID da Operação:
CancelsPreviouslyPlacedOrder

Cancela um pedido feito anteriormente.

Parâmetros

Name Chave Necessário Tipo Description
ID do ficheiro
 FileID True string

Número de identificação do ficheiro.
ID do ficheiro
 FileID integer

O número de identificação do ficheiro.

Devoluções

response
object

Carregar documento de URL da Web para arquivo específico

ID da Operação:
UploadWebURLDocumentToSpecificFile

Carrega o documento de URL da Web no arquivo especificado.

Parâmetros

Name Chave Necessário Tipo Description
ID do ficheiro
 FileID True string

Número de identificação do ficheiro.
Nome do Documento
 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.
Apenas interno
 InternalOnly boolean

Se o documento é apenas interno ou não.
URL da Web
 WebURL string

O URL Web do documento.

Devoluções

Name Caminho Tipo Description
ID do documento
 Document.DocumentID integer

O número de identificação do documento.

Criar novo arquivo

ID da Operação:
CreateNewFile

Cria um novo arquivo.

Parâmetros

Name Chave Necessário Tipo Description
Tipo de entidade
 EntityType string

O nome do tipo de entidade. Pessoa física, jurídica, etc.
IsPrimaryTransactee
 IsPrimaryTransactee boolean

Se o comprador é ou não o principal transactee.
First
 First string

O primeiro nome do comprador.
Last
 Last string

O sobrenome do comprador.
UsePropertyAddress
 UsePropertyAddress boolean

Se o endereço de correspondência deve ou não ser usado como o endereço de propriedade do novo arquivo.
Endereço1
 Address1 string

O número e o nome da rua.
City
 City string

O nome da cidade.
Estado
 State string

As duas letras indicam a abreviatura.
Código Postal
 Zip string

O código postal.
MaritalStatus
 MaritalStatus string

O estado civil do comprador.
Email
 Email string

O endereço de e-mail do comprador.
Tipo de entidade
 EntityType string

O nome do tipo de entidade. Pessoa física, jurídica, etc.
IsPrimaryTransactee
 IsPrimaryTransactee boolean

Se o vendedor é ou não o transacionador principal.
First
 First string

O primeiro nome do vendedor.
Last
 Last string

O sobrenome do vendedor.
UsePropertyAddress
 UsePropertyAddress boolean

Se o endereço de correspondência deve ou não ser usado como o endereço de propriedade do novo arquivo.
Endereço1
 Address1 string

O número e o nome da rua.
City
 City string

O nome da cidade.
Estado
 State string

As duas letras indicam a abreviatura.
Código Postal
 Zip string

O código postal.
MaritalStatus
 MaritalStatus string

O estado civil do vendedor.
Email
 Email string

O endereço de e-mail do vendedor.
EstimadaData de liquidação
 EstimatedSettlementDate string

A data estimada de liquidação 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.
Preço-de-venda
 SalesPrice integer

O preço de venda do imóvel.
ClientFileNumber
 ClientFileNumber string

O número do arquivo do cliente.
PiggybackFileNumber
 PiggybackFileNumber string

O número do arquivo piggyback.
MainFileNumber
 MainFileNumber string

O número do ficheiro principal.
SourceOfBusinessID
 SourceOfBusinessID integer

A fonte do número de identificação comercial.
Observação
 Note string

Uma nota para adicionar ao novo arquivo.
Nome
 Name string

O nome do campo personalizado.
Valor
 Value string

O valor do campo personalizado
LienPosition
 LienPosition integer

A posição de penhora.
Número do Empréstimo
 LoanNumber string

O número do empréstimo.
LoanAmount
 LoanAmount integer

O montante do empréstimo.
Tipo de Empréstimo
 LoanType string

O tipo de empréstimo.
IsPrimary
 IsPrimary boolean

Se este é ou não o endereço da propriedade principal.
Número da rua
 StreetNumber string

O número da rua.
Nome: Rua
 StreetName string

O nome da rua.
City
 City string

O nome da cidade.
Estado
 State string

As duas letras indicam a abreviatura.
Concelho
 County string

O concelho em que a propriedade está localizada.
Código Postal
 Zip string

O código postal.

Devoluções

Name Caminho Tipo Description
ID do ficheiro
 FileID integer

O número de identificação do novo ficheiro.
Número do arquivo
 FileNumber string

O número do arquivo do novo arquivo.
Warnings
 Warnings array of string

Avisos relativos ao novo ficheiro.

Criar novo documento em arquivo específico

ID da Operação:
CreateNewDocumentOnSpecificFile

Cria um novo documento no arquivo especificado.

Parâmetros

Name Chave Necessário Tipo Description
ID do ficheiro
 FileID True string

Número de identificação do ficheiro.
Nome do Documento
 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.
Apenas interno
 InternalOnly string

Se o documento é apenas interno ou não.
Corpo do Documento
 DocumentBody string

O corpo do documento.

Devoluções

Name Caminho Tipo Description
ID do documento
 Document.DocumentID integer

O número de identificação do documento.

Estimativa de Taxa de Fechamento

ID da Operação:
EstimateClosingFee

Estima as taxas de fechamento.

Parâmetros

Name Chave Necessá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.
LiquidaçãoDeclaraçãoVersão
 SettlementStatementVersion string

A versão da declaração de liquidação.
Preço-de-venda
 SalesPrice integer

O preço de venda.
LienPosition
 LienPosition integer

A posição de penhora.
LoanAmount
 LoanAmount integer

O valor do empréstimo.
Tipo de Empréstimo
 LoanType string

O tipo de empréstimo.
IsPrimary
 IsPrimary boolean

Se esta é ou não a propriedade primária.
Número da rua
 StreetNumber string

O número da rua.
Nome: Rua
 StreetName string

O nome da rua.
City
 City string

O nome da cidade.
Estado
 State string

As duas letras indicam a abreviatura.
Concelho
 County string

O nome do concelho.
Código Postal
 Zip string

O código postal.
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 averbamento.

Devoluções

Name Caminho Tipo Description
FechamentoFeeEstimateID
 ClosingFeeEstimate.ClosingFeeEstimateID integer

O número de identificação da estimativa da taxa de encerramento.
HUDFees
 ClosingFeeEstimate.HUDFees array of object

As taxas HUD.
Montante
 ClosingFeeEstimate.HUDFees.Amount integer

O valor da taxa HUD.
Description
 ClosingFeeEstimate.HUDFees.Description string

A descrição da taxa.
Número da linha
 ClosingFeeEstimate.HUDFees.LineNumber string

O número da linha.
CompradorMontante
 ClosingFeeEstimate.HUDFees.BuyerAmount integer

O valor do comprador.
BuyerPOCAmount
 ClosingFeeEstimate.HUDFees.BuyerPOCAmount integer

O valor do POC do comprador.
VendedorMontante
 ClosingFeeEstimate.HUDFees.SellerAmount integer

O valor do vendedor.
SellerPOCAmount
 ClosingFeeEstimate.HUDFees.SellerPOCAmount integer

O valor do POC do vendedor.
OutroPOCAmount
 ClosingFeeEstimate.HUDFees.OtherPOCAmount integer

O outro montante POC.
PartnerTypeID
 ClosingFeeEstimate.HUDFees.OtherPOCPartnerType.PartnerTypeID integer

O número de identificação do tipo de parceiro.
Nome_do_parceiro
 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.
Montante
 ClosingFeeEstimate.GFE.Amount integer

O montante da estimativa.
CredoresPremium
 ClosingFeeEstimate.Premiums.LendersPremium integer

O prémio dos credores.
FullLendersPremium
 ClosingFeeEstimate.Premiums.FullLendersPremium integer

O prémio total dos mutuantes.
Data e Hora
 ClosingFeeEstimate.Timestamp string

O carimbo de data/hora.

Excluir parceiro em arquivo específico

ID da Operação:
DeletePartnerOnSpecificFile

Remove um parceiro do arquivo especificado.

Parâmetros

Name Chave Necessário Tipo Description
ID do ficheiro
 FileID True string

Número de identificação do ficheiro.
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.

Devoluções

response
object

Excluir pedido feito anteriormente

ID da Operação:
DeletePreviouslyPlacedOrder

Cancela um pedido feito anteriormente.

Parâmetros

Name Chave Necessário Tipo Description
ID do ficheiro
 FileID True string

Número de identificação do ficheiro.
ID do ficheiro
 FileID integer

O número de identificação do ficheiro.

Devoluções

response
object

Obter anotações para arquivo específico

ID da Operação:
GetNotesForSpecificFile

Obtém uma lista das notas no arquivo especificado.

Parâmetros

Name Chave Necessário Tipo Description
ID do ficheiro
 FileID True string

Número de identificação do ficheiro.

Devoluções

Name Caminho Tipo Description
Observações
 Notes array of object

A lista de notas no arquivo.
ObservaçãoID
 Notes.NoteID integer

O número de identificação da nota.
Assunto
 Notes.Subject string

O assunto da nota.
Body
 Notes.Body string

O corpo da nota.
ID de utilizador
 Notes.CreatedBy.UserID integer

O número de identificação do utilizador.
Nome
 Notes.CreatedBy.Name string

O nome completo do utilizador.
Primeiro Nome
 Notes.CreatedBy.FirstName string

O primeiro nome do usuário.
Apelido
 Notes.CreatedBy.LastName string

O 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 e-mail dos usuários.
Data de Criação
 Notes.CreatedDate string

A data em que a nota foi criada.
ID do ficheiro
 Notes.FileID integer

O número de identificação do ficheiro.
Agilizar
 Notes.Expedite boolean

Se a nota foi ou não agilizada.

Obter ações para arquivo específico

ID da Operação:
GetActionsForSpecificFile

Obtém todas as ações no arquivo especificado.

Parâmetros

Name Chave Necessário Tipo Description
ID do ficheiro
 FileID True string

Número de identificação do ficheiro.

Devoluções

Name 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.
Nome de Exibição
 Actions.ActionType.DisplayName string

O nome para exibição.
ActionGroupID
 Actions.Group.ActionGroupID integer

O número de identificação do grupo de ação.
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 vencimento
 Actions.StartTask.DueDate string

A data de vencimento da ação.
DueDateLocked
 Actions.StartTask.DueDateLocked boolean

se a data de vencimento está bloqueada ou não.
DoneDate
 Actions.StartTask.DoneDate string

A data de realização da ação.
DoneDateLocked
 Actions.StartTask.DoneDateLocked boolean

Se a data de conclusão está bloqueada ou não.
ID de utilizador
 Actions.StartTask.DoneBy.UserID integer

O número de identificação do utilizador.
Nome
 Actions.StartTask.DoneBy.Name string

O nome de usuário.
CoordinatorTypeID
 Actions.CompleteTask.CoordinatorTypeID integer

O número de identificação do tipo coordenador.
Data de vencimento
 Actions.CompleteTask.DueDate string

A data de vencimento da ação.
DueDateLocked
 Actions.CompleteTask.DueDateLocked boolean

Se a data de vencimento está bloqueada ou não.
DoneDateLocked
 Actions.CompleteTask.DoneDateLocked boolean

Se a data de conclusão está bloqueada ou não.
ID de utilizador
 Actions.CompleteTask.DoneBy.UserID integer

O número de identificação do utilizador.
Nome
 Actions.CompleteTask.DoneBy.Name string

O nome do usuário.

Obter campos personalizados em documentos específicos

ID da Operação:
GetCustomFieldsOnSpecificDocument

Obtenha os campos personalizados no documento especificado.

Parâmetros

Name Chave Necessário Tipo Description
ID do ficheiro
 FileID True string

Número de identificação do ficheiro.
ID do documento
 DocumentID True string

Número de identificação do documento.

Devoluções

Name Caminho Tipo Description
Campos Personalizados
 CustomFields array of object

os campos personalizados.
Nome
 CustomFields.Name string

O nome do campo personalizado.
Valor
 CustomFields.Value string

O valor do campo personalizado.
CustomFieldListCount
 CustomFieldListCount integer

O número de campos personalizados no arquivo.

Obter campos personalizados para arquivo específico

ID da Operação:
GetCustomFieldsForSpecificFile

Obtém os campos personalizados para o arquivo especificado.

Parâmetros

Name Chave Necessário Tipo Description
ID do ficheiro
 FileID True string

Número de identificação do ficheiro.

Devoluções

Name Caminho Tipo Description
Campos Personalizados
 CustomFields array of object

Lista de campos personalizados no arquivo.
Nome
 CustomFields.Name string

O nome do campo personalizado.
Valor
 CustomFields.Value string

O valor do campo personalizado.
CustomFieldListCount
 CustomFieldListCount integer

O número de campos personalizados no arquivo.

Obter documento

ID da Operação:
GetDocument

Obtém informações sobre um documento com a ID especificada.

Parâmetros

Name Chave Necessário Tipo Description
ID do documento
 DocumentID True string

Número de identificação do documento.

Devoluções

Name Caminho Tipo Description
ID do documento
 DocumentID integer

O número de identificação do documento.
Nome do Documento
 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.
Apenas interno
 InternalOnly boolean

Se o documento é apenas interno ou não.
Aprovado
 Approved boolean

Se o documento é aprovado ou não.
ID de utilizador
 CreateUser.UserID integer

O número de identificação do utilizador.
CreateDate
 CreateDate string

A data em que o documento foi criado.

Obter documentos para arquivo específico

ID da Operação:
GetDocumentsForSpecificFile

Obtém todas as informações sobre os documentos no arquivo especificado.

Parâmetros

Name Chave Necessário Tipo Description
ID do ficheiro
 FileID True string

Número de identificação do ficheiro.

Devoluções

Name Caminho Tipo Description
Documents
 Documents array of object

Lista dos documentos constantes do processo.
ID do documento
 Documents.DocumentID integer

O número de identificação do documento.
Nome do Documento
 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.
Apenas interno
 Documents.InternalOnly boolean

Se o documento é apenas interno ou não.
Aprovado
 Documents.Approved boolean

Se o documento é aprovado ou não.
Notas Associadas
 Documents.AssociatedNotes array of object

Notas associadas ao documento.
ObservaçãoID
 Documents.AssociatedNotes.NoteID integer

Anote o número de identificação.
ID de utilizador
 Documents.CreateUser.UserID integer

O número de identificação do utilizador.
Nome
 Documents.CreateUser.Name string

O nome do usuário.
CreateDate
 Documents.CreateDate string

A data em que o documento foi criado.
ID de utilizador
 Documents.ModifyUser.UserID integer

O número de identificação do utilizador.
Nome
 Documents.ModifyUser.Name string

O nome do usuário.
ModificarData
 Documents.ModifyDate string

A data em que o documento foi modificado.

Obter informações atuais do usuário

ID da Operação:
GetCurrentUserInfo

Obtém as informações sobre o usuário conectado no momento.

Devoluções

Name Caminho Tipo Description
Title
 Title string

Título do utilizador.
PasswordExpirationDate
 PasswordExpirationDate string

A data em que a senha expirará.
ID de utilizador
 UserID integer

O número de identificação do utilizador.
Nome
 Name string

O nome do usuário.
Primeiro Nome
 FirstName string

O primeiro nome do usuário.
Apelido
 LastName string

O sobrenome do usuário.
Número de Telemóvel
 ContactInformation.CellPhoneNumber string

O número de telefone celular do usuário.
Endereço de Email
 ContactInformation.EmailAddress string

O endereço de e-mail do usuário.
PreferredCommunicationMethod
 ContactInformation.PreferredCommunicationMethod string

Os usuários preferiram o método de comunicação.
Número de telefone
 ContactInformation.PhoneNumber string

O número de telefone do usuário.
Número de fax
 ContactInformation.FaxNumber string

O número de fax do usuário.
Sítio Web
 ContactInformation.Website string

O site do usuário.

Obter informações de parceiros

ID da Operação:
GetPartnerInformation

Obtém informações sobre um parceiro com a ID especificada.

Parâmetros

Name Chave Necessário Tipo Description
ID da Empresa Parceira
 PartnerCompanyID True string

Número de identificação da empresa parceira.

Devoluções

Name Caminho Tipo Description
ID da EmpresaParceira
 PartnerCompanyID integer

O número de identificação da empresa parceira.
Tipos de parceiros
 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.
Nome_do_parceiro
 PartnerTypes.PartnerTypeName string

O nome do tipo de parceiro.
ID do escritório
 OfficeID integer

O número de identificação do escritório.
Nome do parceiro
 PartnerName string

O nome do parceiro.
Abreviatura da Empresa
 CompanyAbbreviation string

A abreviatura da empresa.
ProperCompanyName
 ProperCompanyName string

O nome completo da empresa.
Endereço1
 MailingAddress.Address1 string

O número e o nome da rua.
Endereço2
 MailingAddress.Address2 string

Mais informações sobre endereços.
City
 MailingAddress.City string

O nome da cidade.
Estado
 MailingAddress.State string

As duas letras indicam a abreviatura.
Código Postal
 MailingAddress.Zip string

O código postal.
Número de telefone
 ContactInformation.PhoneNumber string

O número de telefone do parceiro.
HomeTelefoneNúmero
 ContactInformation.HomePhoneNumber string

O número de telefone residencial do parceiro.
Número de Telemóvel
 ContactInformation.CellPhoneNumber string

O número de telemóvel do parceiro.
Voicemail
 ContactInformation.Voicemail string

O número da caixa postal do parceiro.
Número de fax
 ContactInformation.FaxNumber string

O número de fax do parceiro.
Endereço de Email
 ContactInformation.EmailAddress string

O endereço de e-mail do parceiro.
PreferredCommunicationMethod
 ContactInformation.PreferredCommunicationMethod string

Os parceiros preferiram a forma de comunicação.
Sítio Web
 ContactInformation.Website string

O URL do site parceiro.
ID
 CompanyInformation.ParentCompany.ID integer

O número de identificação.
Nome
 CompanyInformation.ParentCompany.Name string

O nome da empresa-mãe.
ID
 CompanyInformation.PartnerEntity.ID integer

O número de identificação.
nome
 CompanyInformation.PartnerEntity.name string

O nome da entidade parceira.
IsBillable
 CompanyInformation.IsBillable boolean

Se o parceiro é faturável ou não.
IsInvoiceable
 CompanyInformation.IsInvoiceable boolean

Se o imóvel é ou não faturável.
Identificação fiscal
 CompanyInformation.TaxID string

O número de identificação fiscal do parceiro.
Código Contabilístico
 CompanyInformation.AccountingCode string

O código contabilístico.
ComentáriosInstruções especiais
 CompanyInformation.CommentsSpecialInstructions string

Comentários sobre o parceiro.
DontAllowSelectionInSettlement
 CompanyInformation.DontAllowSelectionInSettlement boolean

Permitir ou não a seleção na liquidação.
Necessidades1099
 CompanyInformation.Needs1099 boolean

Se é necessário ou não um 1099.
MWBE
 CompanyInformation.MWBE boolean

Se o parceiro é ou não um MWBE?
SendDocumentsAsWebLinks
 SendDocumentsAsWebLinks boolean

Enviar ou não os documentos como links da web.
WireConfirmationEmailTemplateID
 WireConfirmationEmailTemplateID integer

O número de identificação do modelo de confirmação de fio.
UseOnDesembolsos
 CourierAddress.UseOnDisbursements boolean

Se este valor deve ou não ser utilizado nos desembolsos.
Endereço1
 CourierAddress.Address1 string

O número e o nome da rua.
Endereço2
 CourierAddress.Address2 string

Mais informações sobre endereços.
City
 CourierAddress.City string

O nome da cidade.
Estado
 CourierAddress.State string

As duas letras indicam a abreviatura.
Código Postal
 CourierAddress.Zip string

O código postal.

Obter nota

ID da Operação:
GetNote

Obtém a nota com a ID especificada.

Parâmetros

Name Chave Necessário Tipo Description
ID da nota
 NoteID True string

Anote o número de identificação.

Devoluções

Name Caminho Tipo Description
ObservaçãoID
 NoteID integer

O número de identificação da nota.
Assunto
 Subject string

O assunto da nota.
Body
 Body string

O corpo da nota.
ID de utilizador
 CreatedBy.UserID integer

O número de identificação do utilizador.
Data de Criação
 CreatedDate string

A data em que a nota foi criada.
ID do ficheiro
 FileID integer

O número de identificação do ficheiro.

Obter parceiros para um arquivo específico

ID da Operação:
GetPartnersForSpecificFile

Obtém uma lista de parceiros e suas informações no arquivo especificado.

Parâmetros

Name Chave Necessário Tipo Description
ID do ficheiro
 FileID True string

Número de identificação do ficheiro.

Devoluções

Name Caminho Tipo Description
Partners
 Partners array of object

Informações sobre os parceiros.
ID de utilizador
 Partners.PrimaryEmployee.UserID integer

O número de identificação do utilizador.
Nome
 Partners.PrimaryEmployee.Name string

O nome completo do funcionário.
Primeiro Nome
 Partners.PrimaryEmployee.FirstName string

O primeiro nome do funcionário.
Apelido
 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 e-mail 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.
Nome_do_parceiro
 Partners.PartnerType.PartnerTypeName string

O nome do tipo de parceiro.
Nome do parceiro
 Partners.PartnerName string

O nome do parceiro.

Obter partes para arquivo específico

ID da Operação:
GetPartiesForSpecificFile

Obtém uma lista das partes e suas informações no arquivo especificado.

Parâmetros

Name Chave Necessário Tipo Description
ID do ficheiro
 FileID True string

Número de identificação do ficheiro.

Devoluções

Name 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 jurídica.
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 próprio do comprador.
Médio
 Buyers.Primary.Middle string

Nome do meio do comprador.
Last
 Buyers.Primary.Last string

Apelido 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 próprio do comprador secundário.
Médio
 Buyers.Secondary.Middle string

Nome do meio do comprador secundário.
Last
 Buyers.Secondary.Last string

Apelido do comprador secundário.
UsePropertyAddress
 Buyers.UsePropertyAddress boolean

Usar ou não o endereço.
Endereço1
 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

As duas letras indicam a abreviatura.
Código Postal
 Buyers.Address.Zip string

O código postal.
MaritalStatus
 Buyers.MaritalStatus string

O estado civil da parte.
Email
 Buyers.Email string

O endereço de e-mail da parte.
Telefone Residencial
 Buyers.HomePhone string

O número de telefone residencial da festa.
E-mailSecundário
 Buyers.EmailSecondary string

O endereço de e-mail 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 jurídica.
Tipo de entidade
 Sellers.EntityType string

O tipo de entidade.
Nome da empresa
 Sellers.Primary.BusinessName string

O nome da empresa.
UsePropertyAddress
 Sellers.UsePropertyAddress boolean

Usar ou não o endereço.
Endereço1
 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

As duas letras indicam a abreviatura.
Código Postal
 Sellers.Address.Zip string

O código postal.
MaritalStatus
 Sellers.MaritalStatus string

O estado civil da parte.
Email
 Sellers.Email string

O endereço de e-mail da parte.
Clientes
 Customers array of string

Informação relativa aos clientes.

Obter PDF de Recibo de Estimativa de Taxa de Fechamento

ID da Operação:
GetClosingFeeEstimateReceiptPDF

Obtém o recibo da estimativa da taxa de fechamento no formato pdf.

Parâmetros

Name Chave Necessário Tipo Description
ID da Taxa de Encerramento
 ClosingFeeID True string

Número de identificação da taxa de encerramento.

Devoluções

response
object

Obter recibo de estimativa de taxa de fechamento

ID da Operação:
GetClosingFeeEstimateReceipt

Obtém o recibo da estimativa da taxa de fechamento.

Parâmetros

Name Chave Necessário Tipo Description
ID da Taxa de Encerramento
 ClosingFeeID True string

Número de identificação da taxa de encerramento.

Devoluções

Name Caminho Tipo Description
Data da estimativa
 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.
LiquidaçãoDeclaraçãoVersão
 Request.SettlementStatementVersion string

A versão da declaração de liquidação.
Preço-de-venda
 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 de penhora.
LoanAmount
 Request.Loans.LoanAmount integer

O valor do empréstimo.
Tipo de Empréstimo
 Request.Loans.LoanType string

O tipo de empréstimo.
Propriedades
 Request.Properties array of object

Imóveis na estimativa.
IsPrimary
 Request.Properties.IsPrimary boolean

Se esta é ou não a propriedade primária.
Número da rua
 Request.Properties.StreetNumber string

O número da rua.
Nome: Rua
 Request.Properties.StreetName string

O nome da rua.
City
 Request.Properties.City string

O nome da cidade.
Estado
 Request.Properties.State string

As duas letras indicam a abreviatura.
Concelho
 Request.Properties.County string

O nome do concelho.
Código Postal
 Request.Properties.Zip string

O código postal.
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.
Endossamentos
 Request.Endorsements array of object

Os endossos.
Nome
 Request.Endorsements.Name string

Nome do averbamento.
FechamentoFeeEstimateID
 Response.ClosingFeeEstimateID integer

O número de identificação da estimativa da taxa de encerramento.
HUDFees
 Response.HUDFees array of object

As taxas HUD.
Montante
 Response.HUDFees.Amount integer

O valor da taxa HUD.
Description
 Response.HUDFees.Description string

A descrição da taxa.
Número da linha
 Response.HUDFees.LineNumber string

O número da linha.
CompradorMontante
 Response.HUDFees.BuyerAmount integer

O valor do comprador.
BuyerPOCAmount
 Response.HUDFees.BuyerPOCAmount integer

O valor do POC do comprador.
VendedorMontante
 Response.HUDFees.SellerAmount integer

O valor do vendedor.
SellerPOCAmount
 Response.HUDFees.SellerPOCAmount integer

O valor do POC do vendedor.
OutroPOCAmount
 Response.HUDFees.OtherPOCAmount integer

O outro montante POC.
PartnerTypeID
 Response.HUDFees.OtherPOCPartnerType.PartnerTypeID integer

O número de identificação do tipo de parceiro.
Nome_do_parceiro
 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.
Montante
 Response.GFE.Amount integer

O montante da estimativa.
CredoresPremium
 Response.Premiums.LendersPremium integer

O prémio dos credores.
FullLendersPremium
 Response.Premiums.FullLendersPremium integer

O prémio total dos mutuantes.
Data e Hora
 Response.Timestamp string

O carimbo de data/hora.

Obter transações e tipos de produtos para estimativa e colocação de pedidos

ID da Operação:
GetTransactionAndProductTypesForEstimationAndOrderPlacement

Obtenha tipos de transação e tipos de produtos para estimativa de taxas e colocação de pedidos.

Parâmetros

Name Chave Necessário Tipo Description
Estado
 State string

Estado da localização estimada do imóvel.
Concelho
 County string

Concelho de localização estimada do imóvel.

Devoluções

Name 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.
Tipo de Produto
 ProductType string

O tipo de produto.
ProductTypeID
 ProductTypeID integer

O número de identificação do tipo de produto.
Produtos Auxiliares
 AncillaryProducts array of object

Os produtos auxiliares.
Nome
 AncillaryProducts.Name string

O nome do produto acessório.
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.
Tipo de Produto
 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

ID da Operação:
GetsFilesFromGivenSearchCriteria

Obtém uma lista de arquivos e suas informações com base nos critérios de pesquisa fornecidos.

Parâmetros

Name Chave Necessário Tipo Description
Número do arquivo
 FileNumber string

O número do arquivo.
ID do ficheiro
 FileID integer

O número de identificação do ficheiro.
ID do escritório
 OfficeID integer

O número de identificação do escritório.
ClientsFileNumber
 ClientsFileNumber string

O número do arquivo do cliente.
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 estado.
Nome
 Name string

O nome do status.
Número da apólice
 PolicyNumber string

O número da apólice.
Número de pesquisa
 SearchNumber string

O número da pesquisa.
Número do Empréstimo
 LoanNumber string

O número do empréstimo.
IsPrimary
 IsPrimary boolean

Se este é ou não o endereço da propriedade principal.
Número da rua
 StreetNumber string

O número da rua.
Nome: Rua
 StreetName string

O nome da rua.
City
 City string

O nome da cidade.
Estado
 State string

As duas letras indicam a abreviatura.
Código Postal
 Zip string

O código postal.
Subdivisão
 Subdivision string

A subdivisão em que o imóvel está localizado.
ID da Encomenda
 ParcelID string

O número de identificação da encomenda.
Tipo de entidade
 EntityType string

O tipo de entidade.
First
 First string

O primeiro nome do partido.
Last
 Last string

O sobrenome do partido.
UsePropertyAddress
 UsePropertyAddress boolean

Se este é ou não o endereço da propriedade principal.
MaritalStatus
 MaritalStatus string

O estado civil da parte.
ID de utilizador
 UserID integer

O número de identificação do utilizador.
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 de abertura do ficheiro.
AbertoToDate
 OpenedToDate string

A data em que o arquivo foi fechado.

Devoluções

response
object

Definições

objecto

Este é o tipo 'objeto'.