iMIS
iMIS, um Sistema de Gestão de Engajamento criado especificamente para associações e organizações sem fins lucrativos.
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 | Inovações de Sistemas Informáticos, Inc. |
| URL | https://csiinc.com/support |
| support@csiinc.com |
| Metadados do conector | |
|---|---|
| Editora | Inovações de Sistemas Informáticos, Inc. |
| Sítio Web | https://www.csiinc.com/ |
| Política de privacidade | https://www.csiinc.com/privacy |
| Categorias | Dados; Vendas e CRM |
O iMIS é o único Sistema de Gestão de Engajamento (EMS) do mundo, construído especificamente para atender às necessidades exclusivas de sua organização e apoiar sua melhoria contínua de desempenho. Estenda seus dados iMIS - contatos, atividades, painéis, IQAs e muito mais - para o ecossistema Power Automate and Logic Apps com os gatilhos e ações disponíveis neste conector.
Pré-requisitos
Você precisará de uma instância iMIS ativa e uma assinatura para usar esse conector. Para obter mais informações, veja: https://csi.ms/paprerequisites
Como obter credenciais
Você precisará de uma chave de API para usar esse conector. (Observação: isso não é o mesmo que suas credenciais da API iMIS.) Para obter instruções sobre como obter sua chave de API, consulte: https://csi.ms/paapikey
Introdução ao conector
Pode seguir o nosso guia simples para começar a utilizar o iMIS e o Power Automate aqui: https://csi.ms/pagettingstarted
Depois de estabelecer uma conexão com sucesso, navegue em nossa Biblioteca de ideias de automação para obter ideias sobre automações que você pode criar com iMIS e Power Automate: http://csi.ms/paideas
Problemas conhecidos e limitações
Para obter uma lista completa de limitações conhecidas e problemas atuais, consulte: https://csi.ms/palimitations
Erros e soluções comuns
401 Não autorizado
Quando esse código de status for retornado, inspecione o corpo da resposta e procure um X-CSI-Error-Msg cabeçalho personalizado. Isso ajudará a diagnosticar qual é o problema.
Para obter uma lista completa das etapas comuns de solução de problemas, consulte: https://csi.ms/palimitations
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 CSI | securestring | Insira sua chave de API CSI, encontrada no CSI Cloud Dashboard. | Verdade |
Limites de Limitação
| Name | Chamadas | Período de Renovação |
|---|---|---|
| Chamadas de API por conexão | 100 | 60 segundos |
Ações
| Atualizar o endereço postal de um contacto |
Atualiza o endereço postal de um contato no iMIS. |
| Atualizar um contacto |
Atualiza um registro de contato (pessoa) no iMIS. O ID IMIS É NECESSÁRIO NO CORPO DA SOLICITAÇÃO E SERÁ USADO PARA ENCONTRAR O CONTATO A SER ATUALIZADO. Apenas os campos com valores serão atualizados. Se um campo for deixado em branco, ele não será atualizado. |
| Atualizar um registro de painel de instância única |
Atualize um registro de painel de instância única no iMIS. |
| Atualizar um registro de painel de várias instâncias |
Atualiza um registro de painel de várias instâncias no iMIS. |
| Atualizar uma atividade |
Atualizar um registro de atividade no iMIS |
| Atualizar uma organização |
Atualiza um registro de contato (organização) no iMIS. |
| Criar um contacto |
Cria um registro de contato (pessoa) no iMIS. |
| Criar um registro de painel de várias instâncias |
Cria um registro de painel de várias instâncias no iMIS. |
| Criar uma atividade |
Criar um novo registo de atividade no iMIS |
| Criar uma nova organização |
Cria um registro de contato (organização) no iMIS. |
| Encontrar contactos |
Localiza registros de contato iMIS por vários critérios. A maioria dos campos de pesquisa suporta filtros de pesquisa, como "startsWith:x" ou "contains:x". Consulte a documentação para obter uma lista completa. |
| Excluir um registro de painel de instância única |
Exclui um registro de painel de instância única no iMIS. |
| Excluir um registro de painel de várias instâncias |
Exclui um registro de painel de várias instâncias no iMIS. |
| Executar um IQA |
Executa um IQA iMIS no caminho fornecido. |
| Localizar registos do painel |
Localiza os registros do painel iMIS por vários critérios. A maioria dos campos de pesquisa suporta filtros de pesquisa, como "startsWith:x" ou "contains:x". Consulte a documentação para obter uma lista completa. |
| Obter a imagem de um contacto |
Recupera a foto de perfil de um contato por sua ID iMIS. |
| Obter todos os endereços para um contato |
Recupera uma lista de endereços para um contato. |
| Obter um contacto |
Recupera um único registro de contato por sua ID iMIS. |
| Obter um endereço para um contato |
Recupera um endereço para um contato. |
| Obter um registro de painel de instância única |
Obtém um registro de painel de instância única no iMIS. |
| Obter um registro de painel de várias instâncias |
Obtém um registro de painel de várias instâncias no iMIS. |
| Obter uma atividade por sequência |
Busca um único registro de atividade por seu valor de sequência (SEQN) |
| Procurar atividades |
Pesquise atividades por tipo, ID iMIS e muito mais |
Atualizar o endereço postal de um contacto
Atualiza o endereço postal de um contato no iMIS.
Parâmetros
| Name | Chave | Necessário | Tipo | Description |
|---|---|---|---|---|
|
ID do iMIS
|
id | True | string |
O ID iMIS do endereço a atualizar |
|
Endereço 1
|
address1 | string |
Linha de Endereço 1 |
|
|
Endereço 2
|
address2 | string |
Endereço Linha 2 |
|
|
Nome da cidade
|
city | string |
Nome da cidade no endereço |
|
|
Código do Estado/Província
|
stateProvinceCode | string |
Código abreviado para o estado/província |
|
|
Código Postal
|
postalCode | string |
Código postal ou CEP |
|
|
Código do país
|
countryCode | string |
Código abreviado do país |
|
|
Número de Telefone
|
phone | string |
Número de telefone formatado para este endereço |
|
|
Endereço de E-mail
|
string |
E-mail para este endereço |
||
|
Endereço 3
|
address3 | string |
Endereço Linha 3 |
|
|
Número de Fax
|
fax | string |
Número de fax formatado para este endereço |
Devoluções
- Body
- AddressDTO
Atualizar um contacto
Atualiza um registro de contato (pessoa) no iMIS. O ID IMIS É NECESSÁRIO NO CORPO DA SOLICITAÇÃO E SERÁ USADO PARA ENCONTRAR O CONTATO A SER ATUALIZADO. Apenas os campos com valores serão atualizados. Se um campo for deixado em branco, ele não será atualizado.
Parâmetros
| Name | Chave | Necessário | Tipo | Description |
|---|---|---|---|---|
|
ID do iMIS
|
id | True | string |
O ID iMIS (também referido como: ID de contato, ID do partido) |
|
Prefixo do nome
|
namePrefix | string |
O prefixo do nome do contato (por exemplo, "Mrs.") |
|
|
Nome Próprio
|
firstName | string |
Nome próprio do contacto |
|
|
Nome informal
|
informalName | string |
Nome informal (ou apelido) do contato |
|
|
Segundo Nome
|
middleName | string |
O nome do meio do contato |
|
|
Apelido
|
lastName | string |
Apelido do contacto |
|
|
Sufixo de nome
|
nameSuffix | string |
O sufixo do nome do contato (por exemplo, "Jr.") |
|
|
Título Funcional
|
functionalTitle | string |
O valor do código de título funcional do contato |
|
|
ID da organização pai
|
parentOrganizationId | string |
Especifique o ID iMIS de uma organização pai para vincular essa pessoa |
|
|
Email
|
string |
O endereço de e-mail principal do contato |
||
|
Telefone de trabalho
|
workPhone | string |
O número de telefone profissional do contacto |
|
|
Telefone residencial
|
homePhone | string |
O número de telefone residencial do contato |
|
|
Telemóvel
|
mobilePhone | string |
O número de telemóvel do contacto |
|
|
Fax
|
fax | string |
O número de fax do contacto |
|
|
Sexo
|
gender | string |
O código de género do contacto (por exemplo, "M", "F" ou quaisquer outros códigos definidos) |
|
|
Tipo de Membro
|
memberType | string |
O código de tipo de membro do contato (por exemplo, "NM" ou "WEB") |
|
|
Categoria de Faturação
|
billingCategory | string |
Nome da categoria de faturação do contacto |
|
|
Chave principal
|
majorKey | string |
O principal campo chave do contato |
|
|
Situação
|
status | string |
O código de estado do contacto (por exemplo, "A", "D", "X") |
Devoluções
- Body
- ContactDTO
Atualizar um registro de painel de instância única
Atualize um registro de painel de instância única no iMIS.
Parâmetros
| Name | Chave | Necessário | Tipo | Description |
|---|---|---|---|---|
|
Nome do painel
|
panelNameSingleUpdate | string |
O nome do painel a ser atualizado. |
|
|
body
|
body | dynamic |
Esquema gerado por GetPanelSchema. |
Devoluções
Atualizar um registro de painel de várias instâncias
Atualiza um registro de painel de várias instâncias no iMIS.
Parâmetros
| Name | Chave | Necessário | Tipo | Description |
|---|---|---|---|---|
|
Nome do painel
|
panelNameMultiUpdate | string |
O nome do painel a ser atualizado. |
|
|
body
|
body | dynamic |
Esquema gerado por GetPanelUpdateSchema. |
Devoluções
Atualizar uma atividade
Atualizar um registro de atividade no iMIS
Parâmetros
| Name | Chave | Necessário | Tipo | Description |
|---|---|---|---|---|
|
Códigos de Ação
|
actionCodes | string | ||
|
Tipo de Atividade
|
activityType | string | ||
|
Montante
|
amount | double | ||
|
Sequência de anexos
|
attachSeqn | integer | ||
|
Total de anexos
|
attachTotal | double | ||
|
Número do lote
|
batchNum | string | ||
|
Código da Campanha
|
campaignCode | string | ||
|
Categoria
|
category | string | ||
|
Co-ID
|
coId | string | ||
|
Description
|
description | string | ||
|
Data Efetiva
|
effectiveDate | date | ||
|
Período de carência
|
gracePeriod | integer | ||
|
Intenção de editar
|
intentToEdit | string | ||
|
Código do Memorial/Homenagem
|
memTribCode | string | ||
|
Tipo de Membro
|
memberType | string | ||
|
Próxima data de instalação
|
nextInstallDate | date | ||
|
Observação
|
note | string | ||
|
Nota 2
|
note2 | string | ||
|
Objeto
|
object | string | ||
|
Código da organização
|
orgCode | string | ||
|
Número Trans de origem
|
originatingTransNum | integer | ||
|
Outro Código
|
otherCode | string | ||
|
Outro ID
|
otherId | string | ||
|
Método de Pagamento
|
payMethod | string | ||
|
Código do Produto
|
productCode | string | ||
|
Quantidade
|
quantity | double | ||
|
Solicitação recorrente
|
recurringRequest | boolean | ||
|
Sequence
|
seqn | True | integer | |
|
Identificação do advogado
|
solicitorId | string | ||
|
Código Fonte
|
sourceCode | string | ||
|
Sistema de origem
|
sourceSystem | string | ||
|
Código de estado
|
statusCode | string | ||
|
Valor Tributável
|
taxableValue | double | ||
|
Até à data
|
thruDate | date | ||
|
Data Tickler
|
ticklerDate | date | ||
|
Data da transação
|
transactionDate | date | ||
|
UF1
|
uF1 | string |
Campo de usuário 1 (String) |
|
|
UF2
|
uF2 | string |
Campo de usuário 2 (String) |
|
|
UF3
|
uF3 | string |
Campo de usuário 3 (String) |
|
|
UF4
|
uF4 | double |
Campo de utilizador 4 (decimal) |
|
|
UF5
|
uF5 | double |
Campo de utilizador 5 (decimal) |
|
|
UF6
|
uF6 | date |
Campo de utilizador 6 (Data) |
|
|
UF7
|
uF7 | date |
Campo de utilizador 7 (Data) |
|
|
Units
|
units | double |
Devoluções
- Body
- ActivityDTO
Atualizar uma organização
Atualiza um registro de contato (organização) no iMIS.
Parâmetros
| Name | Chave | Necessário | Tipo | Description |
|---|---|---|---|---|
|
ID do iMIS
|
id | True | string |
O ID iMIS (também referido como: ID de contato, ID do partido) |
|
Nome da Organização
|
organizationName | string |
O nome desta organização |
|
|
URL do site
|
websiteUrl | string |
O URL do site para a página inicial desta organização |
|
|
Email
|
string |
O endereço de e-mail principal da organização |
||
|
Telefone de trabalho
|
workPhone | string |
Número de telefone de trabalho da organização |
|
|
Fax
|
fax | string |
O número de fax da organização |
|
|
Tipo de Membro
|
memberType | string |
Código do tipo de membro da organização (por exemplo, "NM" ou "WEB") |
|
|
Categoria de Faturação
|
billingCategory | string |
O nome da categoria de faturamento da organização |
|
|
Chave principal
|
majorKey | string |
O principal campo chave da organização |
|
|
Situação
|
status | string |
O código de status da organização (por exemplo, "A", "D", "X") |
Devoluções
- Body
- ContactDTO
Criar um contacto
Cria um registro de contato (pessoa) no iMIS.
Parâmetros
| Name | Chave | Necessário | Tipo | Description |
|---|---|---|---|---|
|
Prefixo do nome
|
namePrefix | string |
O prefixo do nome do contato (por exemplo, "Mrs.") |
|
|
Nome Próprio
|
firstName | string |
Nome próprio do contacto |
|
|
Nome informal
|
informalName | string |
Nome informal (ou apelido) do contato |
|
|
Segundo Nome
|
middleName | string |
O nome do meio do contato |
|
|
Apelido
|
lastName | string |
Apelido do contacto |
|
|
Sufixo de nome
|
nameSuffix | string |
O sufixo do nome do contato (por exemplo, "Jr.") |
|
|
Título Funcional
|
functionalTitle | string |
O valor do código de título funcional do contato |
|
|
ID da organização pai
|
parentOrganizationId | string |
Especifique o ID iMIS de uma organização pai para vincular essa pessoa |
|
|
Nome da Organização
|
organizationName | string |
O nome da organização à qual esse contato pertence (não usado se a ID da Organização Pai estiver definida) |
|
|
Email
|
string |
O endereço de e-mail principal do contato |
||
|
Telefone de trabalho
|
workPhone | string |
O número de telefone profissional do contacto |
|
|
Telefone residencial
|
homePhone | string |
O número de telefone residencial do contato |
|
|
Telemóvel
|
mobilePhone | string |
O número de telemóvel do contacto |
|
|
Fax
|
fax | string |
O número de fax do contacto |
|
|
Sexo
|
gender | string |
O código de género do contacto (por exemplo, "M", "F" ou quaisquer outros códigos definidos) |
|
|
Tipo de Membro
|
memberType | string |
O código de tipo de membro do contato (por exemplo, "NM" ou "WEB") |
|
|
Categoria de Faturação
|
billingCategory | string |
Nome da categoria de faturação do contacto |
|
|
Chave principal
|
majorKey | string |
O principal campo chave do contato |
|
|
Situação
|
status | string |
O código de estado do contacto (por exemplo, "A", "D", "X") |
|
|
Data de nascimento
|
birthDate | date |
Data de nascimento do contacto |
|
|
Data de entrada
|
joinDate | date |
Data de adesão do contacto |
Devoluções
- Body
- ContactDTO
Criar um registro de painel de várias instâncias
Cria um registro de painel de várias instâncias no iMIS.
Parâmetros
| Name | Chave | Necessário | Tipo | Description |
|---|---|---|---|---|
|
Nome do painel
|
panelNameMultiCreate | string |
O nome do painel para criar. |
|
|
body
|
body | dynamic |
Esquema gerado por GetPanelCreateSchema. |
Devoluções
Criar uma atividade
Criar um novo registo de atividade no iMIS
Parâmetros
| Name | Chave | Necessário | Tipo | Description |
|---|---|---|---|---|
|
Códigos de Ação
|
actionCodes | string | ||
|
Tipo de Atividade
|
activityType | True | string | |
|
Montante
|
amount | double | ||
|
Sequência de anexos
|
attachSeqn | integer | ||
|
Total de anexos
|
attachTotal | double | ||
|
Número do lote
|
batchNum | string | ||
|
Código da Campanha
|
campaignCode | string | ||
|
Categoria
|
category | string | ||
|
Co-ID
|
coId | string | ||
|
Description
|
description | string | ||
|
Data Efetiva
|
effectiveDate | date | ||
|
Período de carência
|
gracePeriod | integer | ||
|
ID do iMIS
|
id | True | string | |
|
Intenção de editar
|
intentToEdit | string | ||
|
Código do Memorial/Homenagem
|
memTribCode | string | ||
|
Tipo de Membro
|
memberType | string | ||
|
Próxima data de instalação
|
nextInstallDate | date | ||
|
Observação
|
note | string | ||
|
Nota 2
|
note2 | string | ||
|
Objeto
|
object | string | ||
|
Código da organização
|
orgCode | string | ||
|
Número Trans de origem
|
originatingTransNum | integer | ||
|
Outro Código
|
otherCode | string | ||
|
Outro ID
|
otherId | string | ||
|
Método de Pagamento
|
payMethod | string | ||
|
Código do Produto
|
productCode | string | ||
|
Quantidade
|
quantity | double | ||
|
Solicitação recorrente
|
recurringRequest | boolean | ||
|
Identificação do advogado
|
solicitorId | string | ||
|
Código Fonte
|
sourceCode | string | ||
|
Sistema de origem
|
sourceSystem | string | ||
|
Código de estado
|
statusCode | string | ||
|
Valor Tributável
|
taxableValue | double | ||
|
Até à data
|
thruDate | date | ||
|
Data Tickler
|
ticklerDate | date | ||
|
Data da transação
|
transactionDate | date | ||
|
UF1
|
uF1 | string |
Campo de usuário 1 (String) |
|
|
UF2
|
uF2 | string |
Campo de usuário 2 (String) |
|
|
UF3
|
uF3 | string |
Campo de usuário 3 (String) |
|
|
UF4
|
uF4 | double |
Campo de utilizador 4 (decimal) |
|
|
UF5
|
uF5 | double |
Campo de utilizador 5 (decimal) |
|
|
UF6
|
uF6 | date |
Campo de utilizador 6 (Data) |
|
|
UF7
|
uF7 | date |
Campo de utilizador 7 (Data) |
|
|
Units
|
units | double |
Devoluções
- Body
- ActivityDTO
Criar uma nova organização
Cria um registro de contato (organização) no iMIS.
Parâmetros
| Name | Chave | Necessário | Tipo | Description |
|---|---|---|---|---|
|
Nome da Organização
|
organizationName | string |
O nome desta organização |
|
|
URL do site
|
websiteUrl | string |
O URL do site para a página inicial desta organização |
|
|
Email
|
string |
O endereço de e-mail principal da organização |
||
|
Telefone de trabalho
|
workPhone | string |
Número de telefone de trabalho da organização |
|
|
Fax
|
fax | string |
O número de fax da organização |
|
|
Tipo de Membro
|
memberType | string |
Código do tipo de membro da organização (por exemplo, "NM" ou "WEB") |
|
|
Categoria de Faturação
|
billingCategory | string |
O nome da categoria de faturamento da organização |
|
|
Chave principal
|
majorKey | string |
O principal campo chave da organização |
|
|
Situação
|
status | string |
O código de status da organização (por exemplo, "A", "D", "X") |
|
|
Data de entrada
|
joinDate | date |
Data de adesão da organização |
Devoluções
- Body
- ContactDTO
Encontrar contactos
Localiza registros de contato iMIS por vários critérios. A maioria dos campos de pesquisa suporta filtros de pesquisa, como "startsWith:x" ou "contains:x". Consulte a documentação para obter uma lista completa.
Parâmetros
| Name | Chave | Necessário | Tipo | Description |
|---|---|---|---|---|
|
Nome Próprio
|
firstName | string |
Nome do contato (suporta filtros) |
|
|
Apelido
|
lastName | string |
Apelido do contacto (suporta filtros) |
|
|
Nome Completo
|
fullName | string |
Nome completo do contato (suporta filtros) |
|
|
E-mail Principal
|
string |
Endereço de e-mail principal do contato (suporta filtros) |
||
|
Código do tipo de membro
|
memberType | string |
Código de tipo de membro do contato (suporta filtros) |
|
|
Nome da Empresa
|
organization | string |
Nome da organização do contato (suporta filtros) |
|
|
Filtrar tipos de registro
|
recordType | string |
Filtrar tipos de registro (pessoas, organizações) |
|
|
Filtrar Estado Eliminado
|
deleteType | string |
Filtrar status excluído (marcado para exclusão) |
Devoluções
- Body
- ContactListDTO
Excluir um registro de painel de instância única
Exclui um registro de painel de instância única no iMIS.
Parâmetros
| Name | Chave | Necessário | Tipo | Description |
|---|---|---|---|---|
|
Nome do painel
|
panelNameSingleDelete | string |
O nome do painel a ser excluído. |
|
|
body
|
body | dynamic |
Esquema gerado por GetPanelDeleteSchema. |
Excluir um registro de painel de várias instâncias
Exclui um registro de painel de várias instâncias no iMIS.
Parâmetros
| Name | Chave | Necessário | Tipo | Description |
|---|---|---|---|---|
|
Nome do painel
|
panelNameMultiDelete | string |
O nome do painel a ser excluído. |
|
|
body
|
body | dynamic |
Esquema gerado por GetPanelDeleteSchema. |
Executar um IQA
Executa um IQA iMIS no caminho fornecido.
Parâmetros
| Name | Chave | Necessário | Tipo | Description |
|---|---|---|---|---|
|
Caminho IQA
|
iqaPath | string |
O caminho do IQA para executar. |
|
|
body
|
body | dynamic |
Filtros Iqa. |
Devoluções
Localizar registos do painel
Localiza os registros do painel iMIS por vários critérios. A maioria dos campos de pesquisa suporta filtros de pesquisa, como "startsWith:x" ou "contains:x". Consulte a documentação para obter uma lista completa.
Parâmetros
| Name | Chave | Necessário | Tipo | Description |
|---|---|---|---|---|
|
Nome do painel
|
panelNameFindPost | string |
O nome do painel a ser consultado. |
|
|
body
|
body | dynamic |
Esquema gerado por GetPanelSchema. |
Devoluções
Obter a imagem de um contacto
Recupera a foto de perfil de um contato por sua ID iMIS.
Parâmetros
| Name | Chave | Necessário | Tipo | Description |
|---|---|---|---|---|
|
ID do iMIS
|
contactId | True | string |
ID do iMIS |
Devoluções
Representa a foto de perfil de um contato
- Body
- ContactPictureDTO
Obter todos os endereços para um contato
Recupera uma lista de endereços para um contato.
Parâmetros
| Name | Chave | Necessário | Tipo | Description |
|---|---|---|---|---|
|
ID do iMIS
|
contactId | True | string |
O ID iMIS para obter os endereços para |
Devoluções
- Body
- AddressListDTO
Obter um contacto
Recupera um único registro de contato por sua ID iMIS.
Parâmetros
| Name | Chave | Necessário | Tipo | Description |
|---|---|---|---|---|
|
ID do iMIS
|
contactId | True | string |
ID do iMIS |
Devoluções
- Body
- ContactDTO
Obter um endereço para um contato
Recupera um endereço para um contato.
Parâmetros
| Name | Chave | Necessário | Tipo | Description |
|---|---|---|---|---|
|
ID do iMIS
|
contactId | True | string |
O ID iMIS para obter o endereço para |
|
Finalidade do endereço
|
addressPurpose | True | string |
Deve ser um nome de finalidade de endereço bem definido no iMIS |
Devoluções
- Body
- AddressDTO
Obter um registro de painel de instância única
Obtém um registro de painel de instância única no iMIS.
Parâmetros
| Name | Chave | Necessário | Tipo | Description |
|---|---|---|---|---|
|
Nome do painel
|
panelNameSingleGet | string |
O nome do painel a ser recuperado. |
|
|
body
|
body | dynamic |
Esquema gerado por GetPanelGetSchema. |
Devoluções
Obter um registro de painel de várias instâncias
Obtém um registro de painel de várias instâncias no iMIS.
Parâmetros
| Name | Chave | Necessário | Tipo | Description |
|---|---|---|---|---|
|
Nome do painel
|
panelNameMultiGet | string |
O nome do painel a ser recuperado. |
|
|
body
|
body | dynamic |
Esquema gerado por GetPanelGetSchema. |
Devoluções
Obter uma atividade por sequência
Busca um único registro de atividade por seu valor de sequência (SEQN)
Parâmetros
| Name | Chave | Necessário | Tipo | Description |
|---|---|---|---|---|
|
Número de sequência
|
sequenceNumber | True | integer |
Número sequencial |
Devoluções
- Body
- ActivityDTO
Procurar atividades
Pesquise atividades por tipo, ID iMIS e muito mais
Parâmetros
| Name | Chave | Necessário | Tipo | Description |
|---|---|---|---|---|
|
Tipo de Atividade
|
activityType | string |
O código do tipo de atividade |
|
|
ID do iMIS
|
imisId | string |
O ID iMIS |
|
|
Código do Produto
|
productCode | string |
O código do produto |
|
|
Categoria
|
category | string |
A categoria |
|
|
Data da transação em ou antes
|
transactionDateBefore | date |
Data da transação em ou antes |
|
|
Data da transação após
|
transactionDateAfter | date |
Data da transação após |
|
|
Data de entrada em vigor ou antes
|
effectiveDateBefore | date |
Data de entrada em vigor em ou antes |
|
|
Data de entrada em vigor após
|
effectiveDateAfter | date |
Data de entrada em vigor após |
|
|
Até à data em ou antes
|
thruDateBefore | date |
Até a data em ou antes |
|
|
Até a data depois
|
thruDateAfter | date |
Até à data após |
|
|
Ordenar Por
|
sortBy | string |
O nome da propriedade para classificar por |
|
|
Ordenar Descendente
|
sortDesc | boolean |
Se a ordem de classificação deve ser decrescente (o padrão é crescente) |
Devoluções
- Body
- ActivityListDTO
Acionadores
| Quando uma atividade é adicionada |
Quando uma atividade é adicionada |
| Quando uma encomenda é adicionada |
Quando uma encomenda é adicionada |
Quando uma atividade é adicionada
Quando uma encomenda é adicionada
Definições
AtividadeDTO
| Name | Caminho | Tipo | Description |
|---|---|---|---|
|
Códigos de Ação
|
actionCodes | string | |
|
Tipo de Atividade
|
activityType | string | |
|
Montante
|
amount | double | |
|
Sequência de anexos
|
attachSeqn | integer | |
|
Total de anexos
|
attachTotal | double | |
|
Número do lote
|
batchNum | string | |
|
Código da Campanha
|
campaignCode | string | |
|
Categoria
|
category | string | |
|
Co-ID
|
coId | string | |
|
Description
|
description | string | |
|
Data Efetiva
|
effectiveDate | date | |
|
Período de carência
|
gracePeriod | integer | |
|
ID do iMIS
|
id | string | |
|
Intenção de editar
|
intentToEdit | string | |
|
Código do Memorial/Homenagem
|
memTribCode | string | |
|
Tipo de Membro
|
memberType | string | |
|
Próxima data de instalação
|
nextInstallDate | date | |
|
Observação
|
note | string | |
|
Nota 2
|
note2 | string | |
|
Objeto
|
object | string | |
|
Código da organização
|
orgCode | string | |
|
Número Trans de origem
|
originatingTransNum | integer | |
|
Outro Código
|
otherCode | string | |
|
Outro ID
|
otherId | string | |
|
Método de Pagamento
|
payMethod | string | |
|
Código do Produto
|
productCode | string | |
|
Quantidade
|
quantity | double | |
|
Solicitação recorrente
|
recurringRequest | boolean | |
|
Identificação do advogado
|
solicitorId | string | |
|
Código Fonte
|
sourceCode | string | |
|
Sistema de origem
|
sourceSystem | string | |
|
Código de estado
|
statusCode | string | |
|
Valor Tributável
|
taxableValue | double | |
|
Até à data
|
thruDate | date | |
|
Data Tickler
|
ticklerDate | date | |
|
Data da transação
|
transactionDate | date | |
|
UF1
|
uF1 | string |
Campo de usuário 1 (String) |
|
UF2
|
uF2 | string |
Campo de usuário 2 (String) |
|
UF3
|
uF3 | string |
Campo de usuário 3 (String) |
|
UF4
|
uF4 | double |
Campo de utilizador 4 (decimal) |
|
UF5
|
uF5 | double |
Campo de utilizador 5 (decimal) |
|
UF6
|
uF6 | date |
Campo de utilizador 6 (Data) |
|
UF7
|
uF7 | date |
Campo de utilizador 7 (Data) |
|
Units
|
units | double | |
|
Sequence
|
seqn | integer |
O valor da sequência da atividade (chave primária) |
Listde de AtividadesDTO
| Name | Caminho | Tipo | Description |
|---|---|---|---|
|
Lista de Atividades
|
value | array of ActivityDTO |
A lista de registos de atividade |
EndereçoDTO
| Name | Caminho | Tipo | Description |
|---|---|---|---|
|
ID do endereço
|
addressId | string |
ID exclusivo para este registro de endereço. |
|
Linhas de endereço
|
addressLines | string |
Linhas de rua de endereço separadas por Newline. |
|
Nome da cidade
|
city | string |
Nome da cidade no endereço. |
|
Código do Estado/Província
|
stateProvinceCode | string |
Código abreviado para o estado/província. |
|
Código Postal
|
postalCode | string |
Código postal ou CEP. |
|
Código do país
|
countryCode | string |
Código abreviado do país. |
|
Número de Telefone
|
phone | string |
Número de telefone formatado para este endereço. |
|
Endereço de E-mail
|
string |
E-mail para este endereço. |
|
|
Endereço completo
|
fullAddress | string |
Endereço computado completo com novas linhas. |
|
Nome e Endereço Completo
|
nameAndFullAddress | string |
Endereço completo computado com o nome do contato na primeira linha. |
|
Finalidade do endereço
|
addressPurpose | string |
Nome da finalidade do endereço (categoria). |
|
Lista de preferências de comunicação
|
communicationPreferences | array of string |
Lista de tipos de preferência de comunicação. |
EndereçoListDTO
| Name | Caminho | Tipo | Description |
|---|---|---|---|
|
Lista de endereços
|
addresses | array of AddressDTO |
A lista de objetos de endereço para o contato especificado |
ContatoDTO
| Name | Caminho | Tipo | Description |
|---|---|---|---|
|
Tipo de Contacto
|
contactType | string |
O tipo de contacto (organização ou pessoa) |
|
ID do iMIS
|
id | string |
O ID iMIS (também referido como: ID de contato, ID do partido) |
|
Nome
|
name | string |
O nome completo da pessoa computada, ou nome da organização, do contato |
|
Prefixo do nome
|
namePrefix | string |
O prefixo do nome do contato (por exemplo, "Mrs.") |
|
Nome Próprio
|
firstName | string |
Nome próprio do contacto |
|
Nome informal
|
informalName | string |
Nome informal (ou apelido) do contato |
|
Segundo Nome
|
middleName | string |
O nome do meio do contato |
|
Apelido
|
lastName | string |
Apelido do contacto |
|
Sufixo de nome
|
nameSuffix | string |
O sufixo do nome do contato (por exemplo, "Jr.") |
|
Título Funcional
|
functionalTitle | string |
O título funcional do contacto, incluindo eventuais designações |
|
É Membro
|
isMember | boolean |
Sinalizador que especifica se esse contato é um membro da organização |
|
Está ativo
|
isActive | boolean |
Sinalizador que especifica se este contato está marcado como ativo (ou seja, não marcado para exclusão, falecido, etc) |
|
Nome da Organização
|
organizationName | string |
O nome da organização à qual esse contato pertence |
|
ID da Organização
|
organizationId | string |
Para tipos de pessoa, especifica o ID da organização pai vinculado |
|
Email
|
string |
O endereço de e-mail principal do contato |
|
|
Telefone de trabalho
|
workPhone | string |
O número de telefone profissional do contacto |
|
Telefone residencial
|
homePhone | string |
O número de telefone residencial do contato |
|
Telemóvel
|
mobilePhone | string |
O número de telemóvel do contacto |
|
Fax
|
fax | string |
O número de fax do contacto |
|
Sexo
|
gender | string |
O código de género do contacto (por exemplo, "M", "F" ou quaisquer outros códigos definidos) |
|
Tipo de Membro
|
memberType | string |
O código de tipo de membro do contato (por exemplo, "NM" ou "WEB") |
|
Categoria de Faturação
|
billingCategory | string |
Nome da categoria de faturação do contacto |
|
Chave principal
|
majorKey | string |
O principal campo chave do contato |
|
Situação
|
status | string |
O código de estado do contacto (por exemplo, "A", "D", "X") |
|
Chave de contato
|
contactKey | string |
A chave do contato, às vezes referida como "Net ID" (um Guid) |
|
Data de nascimento
|
birthDate | date |
Data de nascimento do contacto |
|
Data de entrada
|
joinDate | date |
Data de adesão do contacto |
|
Pago através de
|
paidThruDate | date |
A adesão do contato paga até a data (se for membro) |
|
Renovado Thru
|
renewedThruDate | date |
O contato é renovado até a data |
ContactListDTO
| Name | Caminho | Tipo | Description |
|---|---|---|---|
|
Lista de Contactos
|
value | array of ContactDTO |
A lista de registos de contactos |
ContatoImagemDTO
Representa a foto de perfil de um contato
| Name | Caminho | Tipo | Description |
|---|---|---|---|
|
ID do iMIS
|
id | string |
O ID iMIS associado a esta imagem |
|
Dados de imagem
|
pictureData | byte |
Os dados da imagem |
OrderDTO
| Name | Caminho | Tipo | Description |
|---|---|---|---|
|
Enviar para o endereço Linha 1
|
address1 | string | |
|
Enviar para o endereço Linha 2
|
address2 | string | |
|
Enviar para a linha de endereço 3
|
address3 | string | |
|
Enviar para o código de formato de endereço
|
addressFormat | integer | |
|
Valor do Saldo
|
balance | double | |
|
Número do lote
|
batchNumber | string | |
|
Bill para iMIS ID
|
billToId | string | |
|
Enviar para a cidade de endereço
|
city | string | |
|
ID iMIS da empresa
|
companyId | string | |
|
Tipo de Membro da Empresa
|
companyMemberType | string | |
|
Nome da Empresa
|
company | string | |
|
Código de classificação da empresa
|
companySort | string | |
|
Enviar para o país de endereço
|
country | string | |
|
Referência do Cliente
|
customerReference | string | |
|
Enviar para endereço de e-mail
|
string | ||
|
Frete 1 Valor
|
freight1 | double | |
|
Frete 2 Valor
|
freight2 | double | |
|
Shipp para endereço completo
|
fullAddress | string | |
|
Enviar para nome completo
|
fullName | string | |
|
Manuseamento de 1 Montante
|
handling1 | double | |
|
Manuseamento 2 Montante
|
handling2 | double | |
|
Código de retenção
|
holdCode | string | |
|
Segurar comentário
|
holdComment | string | |
|
Mantém-se?
|
holdFlag | boolean | |
|
Número de referência da fatura
|
invoiceReferenceNumber | integer | |
|
Enviar para o tipo de membro
|
memberType | string | |
|
Notas de encomenda
|
notes | string | |
|
Data da encomenda
|
orderDate | date | |
|
Número da encomenda
|
orderNumber | double | |
|
Código do tipo de encomenda
|
orderTypeCode | string | |
|
Código da entidade
|
entityCode | string | |
|
Tipo de Pagamento
|
payType | string | |
|
Enviar para o telefone
|
phone | string | |
|
Código Fonte
|
sourceCode | string | |
|
Enviar para iMIS ID
|
shipToId | string | |
|
Etapa do pedido
|
stage | string | |
|
Navio Para Estado/Província
|
stateProvince | string | |
|
Estado da Encomenda
|
status | string | |
|
Imposto 1 Valor
|
tax1 | double | |
|
Imposto 2 Valor
|
tax2 | double | |
|
Imposto 3 Valor
|
tax3 | double | |
|
Taxa de Imposto 1
|
taxRate1 | double | |
|
Taxa de Imposto 2
|
taxRate2 | double | |
|
Taxa de Imposto 3
|
taxRate3 | double | |
|
Título da Encomenda
|
title | string | |
|
Encargos totais da encomenda
|
totalCharges | double | |
|
Total de Pagamentos da Encomenda
|
totalPayments | double | |
|
Quantidade Total Backorder
|
totalQuantityBackordered | integer | |
|
Quantidade Total Encomendada
|
totalQuantityOrdered | integer | |
|
Enviar para código postal
|
zip | string | |
|
Sistema de origem
|
sourceSystem | string | |
|
Código de desconto
|
discountCode | string | |
|
Código do IVA
|
vatTaxCodeFh | string | |
|
Total não descontado
|
undiscountedTotal | double | |
|
Código dos Termos
|
termsCode | string | |
|
Taxa de Imposto
|
taxRateFh | double | |
|
Imposto 1 Autor
|
taxAuthor1 | string | |
|
Imposto 2 Autor
|
taxAuthor2 | string | |
|
Imposto 3 Autor
|
taxAuthor3 | string | |
|
Isentos de Impostos
|
taxExempt | string | |
|
Afeta o inventário?
|
affectInventory | boolean | |
|
Valor do Imposto de Frete
|
freightTax | double | |
|
Tratamento do valor do imposto
|
handlingTax | double | |
|
Data da fatura
|
invoiceDate | date | |
|
Número da Fatura
|
invoiceNumber | integer | |
|
Valor total da linha
|
lineTotal | double | |
|
Método de envio
|
shipMethod | string | |
|
Data dos Documentos de Envio
|
shipPapersDateTime | date | |
|
Data de envio
|
shippedDateTime | date | |
|
Peso Total
|
totalWeight | double | |
|
Inserido por
|
enteredBy | string | |
|
Data/hora inserida
|
enteredDateTime | date |
OrderListDTO
| Name | Caminho | Tipo | Description |
|---|---|---|---|
|
Lista de Encomendas
|
value | array of OrderDTO |
A lista de registros de pedidos |