iMIS
IMIS, um Sistema de Gerenciamento de Participação criado com finalidade para associações e organizações sem fins lucrativos.
Esse conector está disponível nos seguintes produtos e regiões:
| Service | Class | Regions |
|---|---|---|
| Copilot Studio | Premium | Todas as regiões do Power Automate , exceto as seguintes: – Governo dos EUA (GCC) – Governo dos EUA (GCC High) - China Cloud operado pela 21Vianet - Departamento de Defesa dos EUA (DoD) |
| Aplicativos Lógicos | Standard | Todas as regiões dos Aplicativos Lógicos , exceto as seguintes: – Regiões do Azure Governamental - Regiões do Azure China - Departamento de Defesa dos EUA (DoD) |
| Power Apps | Premium | Todas as regiões do Power Apps , exceto as seguintes: – Governo dos EUA (GCC) – Governo dos EUA (GCC High) - China Cloud operado pela 21Vianet - Departamento de Defesa dos EUA (DoD) |
| Power Automate | Premium | Todas as regiões do Power Automate , exceto as seguintes: – Governo dos EUA (GCC) – Governo dos EUA (GCC High) - China Cloud operado pela 21Vianet - Departamento de Defesa dos EUA (DoD) |
| Contato | |
|---|---|
| Nome | Computer System Innovations, Inc. |
| URL | https://csiinc.com/support |
| support@csiinc.com |
| Metadados do conector | |
|---|---|
| Publicador | Computer System Innovations, Inc. |
| Site | https://www.csiinc.com/ |
| Política de privacidade | https://www.csiinc.com/privacy |
| Categorias | Dados; Vendas e CRM |
O iMIS é o único EMS (Engagement Management System) do mundo, criado para atender às necessidades exclusivas da sua organização e dar suporte à melhoria contínua de desempenho. Estenda seus dados iMIS - contatos, atividades, painéis, IQAs e muito mais - para o ecossistema do Power Automate e aplicativos lógicos com os gatilhos e ações disponíveis neste conector.
Pré-requisitos
Você precisará de uma instância do iMIS ativa e de uma assinatura para usar esse conector. Para obter mais informações, confira: 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 de API iMIS.) Para obter instruções sobre como obter sua chave de API, consulte: https://csi.ms/paapikey
Introdução ao conector
Você pode seguir nosso guia simples para começar a usar o iMIS e o Power Automate aqui: https://csi.ms/pagettingstarted
Depois de estabelecer uma conexão com êxito, procure nossa Biblioteca de Ideias de Automação para obter ideias sobre automações que podem ser criadas com o iMIS e o Power Automate: http://csi.ms/paideas
Problemas e limitações conhecidos
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
Criando uma conexão
O conector dá suporte aos seguintes tipos de autenticação:
| Default | Parâmetros para criar conexão. | Todas as regiões | Não compartilhável |
Padrão
Aplicável: todas as regiões
Parâmetros para criar conexão.
Essa não é uma conexão compartilhável. Se o aplicativo de energia for compartilhado com outro usuário, outro usuário será solicitado a criar uma nova conexão explicitamente.
| Nome | Tipo | Description | Obrigatório |
|---|---|---|---|
| Chave de API do CSI | secureString | Insira sua Chave de API CSI, encontrada no Painel de Nuvem do CSI. | Verdade |
Limitações
| Nome | Chamadas | Período de renovação |
|---|---|---|
| Chamadas à API por conexão | 100 | 60 segundos |
Ações
| Atualizar o endereço de endereçamento de um contato |
Atualiza o endereço de endereçamento de um contato no iMIS. |
| Atualizar um contato |
Atualiza um registro de contato (pessoa) no iMIS. A ID do iMIS é necessária no corpo da solicitação e será usada para localizar o contato a ser atualizado. Somente 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 único registro de painel de instância 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 contato |
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 registro de atividade no iMIS |
| Criar uma organização |
Cria um registro de contato (organização) no iMIS. |
| 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 uma IQA |
Executa uma IQA iMIS no caminho fornecido. |
| Localizar atividades |
Pesquisar atividades por tipo, ID do iMIS e muito mais |
| Localizar contatos |
Localiza registros de contato do iMIS por vários critérios. A maioria dos campos de pesquisa dá suporte a filtros de pesquisa, como "startsWith:x" ou "contains:x". Consulte a documentação para obter uma lista completa. |
| Localizar registros do painel |
Localiza registros de painel iMIS por vários critérios. A maioria dos campos de pesquisa dá suporte a filtros de pesquisa, como "startsWith:x" ou "contains:x". Consulte a documentação para obter uma lista completa. |
| Obter a imagem de um contato |
Recupera a imagem de perfil de um contato pela ID do iMIS. |
| Obter todos os endereços para um contato |
Recupera uma lista de endereços para um contato. |
| Obter um contato |
Recupera um único registro de contato pela ID do 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 SEQN (sequência) |
Atualizar o endereço de endereçamento de um contato
Atualiza o endereço de endereçamento de um contato no iMIS.
Parâmetros
| Nome | Chave | Obrigatório | Tipo | Description |
|---|---|---|---|---|
|
ID do iMIS
|
id | True | string |
A ID do iMIS do endereço a ser atualizado |
|
Endereço 1
|
address1 | string |
Linha de endereço 1 |
|
|
Endereço 2
|
address2 | string |
Linha de endereço 2 |
|
|
Nome da Cidade
|
city | string |
Nome da cidade no endereço |
|
|
Código de estado/província
|
stateProvinceCode | string |
Código abreviado para o estado/província |
|
|
Código postal
|
postalCode | string |
CeP ou CEP |
|
|
Código do país
|
countryCode | string |
Código de país abreviado |
|
|
Número de Telefone
|
phone | string |
Número de telefone formatado para este endereço |
|
|
Endereço eletrônico
|
string |
Email para este endereço |
||
|
Endereço 3
|
address3 | string |
Linha de Endereço 3 |
|
|
Número do fax
|
fax | string |
Número de fax formatado para este endereço |
Retornos
- Corpo
- AddressDTO
Atualizar um contato
Atualiza um registro de contato (pessoa) no iMIS. A ID do iMIS é necessária no corpo da solicitação e será usada para localizar o contato a ser atualizado. Somente campos com valores serão atualizados. Se um campo for deixado em branco, ele não será atualizado.
Parâmetros
| Nome | Chave | Obrigatório | Tipo | Description |
|---|---|---|---|---|
|
ID do iMIS
|
id | True | string |
A ID do iMIS (também conhecida como: ID de contato, ID da parte) |
|
Prefixo de nome
|
namePrefix | string |
Prefixo de nome do contato (por exemplo, "Sra.") |
|
|
Primeiro Nome
|
firstName | string |
O nome do contato |
|
|
Nome informal
|
informalName | string |
Nome informal do contato (ou apelido) |
|
|
Nome do Meio
|
middleName | string |
O nome do meio do contato |
|
|
Apelido
|
lastName | string |
O sobrenome do contato |
|
|
Sufixo de nome
|
nameSuffix | string |
Sufixo de 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 a ID do iMIS de uma organização pai para vincular essa pessoa |
|
|
Email
|
string |
O endereço de email principal do contato |
||
|
Telefone De Trabalho
|
workPhone | string |
O número de telefone do trabalho do contato |
|
|
Telefone Residencial
|
homePhone | string |
O número de telefone da casa do contato |
|
|
Celular
|
mobilePhone | string |
O número de telefone celular do contato |
|
|
Fac-símile
|
fax | string |
O número de fax do contato |
|
|
Gênero
|
gender | string |
O código de gênero do contato (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 cobrança
|
billingCategory | string |
O nome da categoria de cobrança do contato |
|
|
Chave Principal
|
majorKey | string |
O campo de chave principal do contato |
|
|
Situação
|
status | string |
O código de status do contato (por exemplo, "A", "D", "X") |
Retornos
- Corpo
- ContactDTO
Atualizar um registro de painel de instância única
Atualize um único registro de painel de instância no iMIS.
Parâmetros
| Nome | Chave | Obrigatório | Tipo | Description |
|---|---|---|---|---|
|
Nome do painel
|
panelNameSingleUpdate | string |
O nome do painel a ser atualizado. |
|
|
body
|
body | dynamic |
Esquema gerado por GetPanelSchema. |
Retornos
Atualizar um registro de painel de várias instâncias
Atualiza um registro de painel de várias instâncias no iMIS.
Parâmetros
| Nome | Chave | Obrigatório | Tipo | Description |
|---|---|---|---|---|
|
Nome do painel
|
panelNameMultiUpdate | string |
O nome do painel a ser atualizado. |
|
|
body
|
body | dynamic |
Esquema gerado por GetPanelUpdateSchema. |
Retornos
Atualizar uma atividade
Atualizar um registro de atividade no iMIS
Parâmetros
| Nome | Chave | Obrigatório | Tipo | Description |
|---|---|---|---|---|
|
Códigos de ação
|
actionCodes | string | ||
|
Tipo de atividade
|
activityType | string | ||
|
Quantidade
|
amount | double | ||
|
Sequência de anexos
|
attachSeqn | integer | ||
|
Total de Anexos
|
attachTotal | double | ||
|
Número do Lote
|
batchNum | string | ||
|
Código de campanha
|
campaignCode | string | ||
|
Categoria
|
category | string | ||
|
Co-ID
|
coId | string | ||
|
Description
|
description | string | ||
|
Data de Vigência
|
effectiveDate | date | ||
|
Período de carência
|
gracePeriod | integer | ||
|
Intenção de editar
|
intentToEdit | string | ||
|
Código memorial/tributo
|
memTribCode | string | ||
|
Tipo de Membro
|
memberType | string | ||
|
Próxima Data de Instalação
|
nextInstallDate | date | ||
|
Observação
|
note | string | ||
|
Nota 2
|
note2 | string | ||
|
Object
|
object | string | ||
|
Código da organização
|
orgCode | string | ||
|
Número Trans de origem
|
originatingTransNum | integer | ||
|
Outro código
|
otherCode | string | ||
|
Outra ID
|
otherId | string | ||
|
Método Pay
|
payMethod | string | ||
|
Código do produto
|
productCode | string | ||
|
Quantidade
|
quantity | double | ||
|
Solicitação recorrente
|
recurringRequest | boolean | ||
|
Sequence
|
seqn | True | integer | |
|
ID do advogado
|
solicitorId | string | ||
|
Código-fonte
|
sourceCode | string | ||
|
Sistema de origem
|
sourceSystem | string | ||
|
Código de status
|
statusCode | string | ||
|
Valor tributável
|
taxableValue | double | ||
|
Data do Thru
|
thruDate | date | ||
|
Data do tique-taque
|
ticklerDate | date | ||
|
Data da Transação
|
transactionDate | date | ||
|
UF1
|
uF1 | string |
Campo de usuário 1 (cadeia de caracteres) |
|
|
UF2
|
uF2 | string |
Campo de usuário 2 (cadeia de caracteres) |
|
|
UF3
|
uF3 | string |
Campo de usuário 3 (cadeia de caracteres) |
|
|
UF4
|
uF4 | double |
Campo de Usuário 4 (Decimal) |
|
|
UF5
|
uF5 | double |
Campo de Usuário 5 (Decimal) |
|
|
UF6
|
uF6 | date |
Campo de Usuário 6 (Data) |
|
|
UF7
|
uF7 | date |
Campo de Usuário 7 (Data) |
|
|
Unidades
|
units | double |
Retornos
- Corpo
- ActivityDTO
Atualizar uma organização
Atualiza um registro de contato (organização) no iMIS.
Parâmetros
| Nome | Chave | Obrigatório | Tipo | Description |
|---|---|---|---|---|
|
ID do iMIS
|
id | True | string |
A ID do iMIS (também conhecida como: ID de contato, ID da parte) |
|
Nome da Organização
|
organizationName | string |
O nome desta organização |
|
|
URL do site
|
websiteUrl | string |
A URL do site para a home page desta organização |
|
|
Email
|
string |
O endereço de email principal da organização |
||
|
Telefone De Trabalho
|
workPhone | string |
Número de telefone de trabalho da organização |
|
|
Fac-símile
|
fax | string |
O número de fax da organização |
|
|
Tipo de Membro
|
memberType | string |
Código de tipo de membro da organização (por exemplo, "NM" ou "WEB") |
|
|
Categoria de cobrança
|
billingCategory | string |
Nome da categoria de cobrança da organização |
|
|
Chave Principal
|
majorKey | string |
O principal campo de chave da organização |
|
|
Situação
|
status | string |
Código de status da organização (por exemplo, "A", "D", "X") |
Retornos
- Corpo
- ContactDTO
Criar um contato
Cria um registro de contato (pessoa) no iMIS.
Parâmetros
| Nome | Chave | Obrigatório | Tipo | Description |
|---|---|---|---|---|
|
Prefixo de nome
|
namePrefix | string |
Prefixo de nome do contato (por exemplo, "Sra.") |
|
|
Primeiro Nome
|
firstName | string |
O nome do contato |
|
|
Nome informal
|
informalName | string |
Nome informal do contato (ou apelido) |
|
|
Nome do Meio
|
middleName | string |
O nome do meio do contato |
|
|
Apelido
|
lastName | string |
O sobrenome do contato |
|
|
Sufixo de nome
|
nameSuffix | string |
Sufixo de 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 a ID do 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 email principal do contato |
||
|
Telefone De Trabalho
|
workPhone | string |
O número de telefone do trabalho do contato |
|
|
Telefone Residencial
|
homePhone | string |
O número de telefone da casa do contato |
|
|
Celular
|
mobilePhone | string |
O número de telefone celular do contato |
|
|
Fac-símile
|
fax | string |
O número de fax do contato |
|
|
Gênero
|
gender | string |
O código de gênero do contato (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 cobrança
|
billingCategory | string |
O nome da categoria de cobrança do contato |
|
|
Chave Principal
|
majorKey | string |
O campo de chave principal do contato |
|
|
Situação
|
status | string |
O código de status do contato (por exemplo, "A", "D", "X") |
|
|
Data de nascimento
|
birthDate | date |
A data de nascimento do contato |
|
|
Data de ingresso
|
joinDate | date |
A data de ingresso do contato |
Retornos
- Corpo
- 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
| Nome | Chave | Obrigatório | Tipo | Description |
|---|---|---|---|---|
|
Nome do painel
|
panelNameMultiCreate | string |
O nome do painel no qual criar. |
|
|
body
|
body | dynamic |
Esquema gerado por GetPanelCreateSchema. |
Retornos
Criar uma atividade
Criar um novo registro de atividade no iMIS
Parâmetros
| Nome | Chave | Obrigatório | Tipo | Description |
|---|---|---|---|---|
|
Códigos de ação
|
actionCodes | string | ||
|
Tipo de atividade
|
activityType | True | string | |
|
Quantidade
|
amount | double | ||
|
Sequência de anexos
|
attachSeqn | integer | ||
|
Total de Anexos
|
attachTotal | double | ||
|
Número do Lote
|
batchNum | string | ||
|
Código de campanha
|
campaignCode | string | ||
|
Categoria
|
category | string | ||
|
Co-ID
|
coId | string | ||
|
Description
|
description | string | ||
|
Data de Vigência
|
effectiveDate | date | ||
|
Período de carência
|
gracePeriod | integer | ||
|
ID do iMIS
|
id | True | string | |
|
Intenção de editar
|
intentToEdit | string | ||
|
Código memorial/tributo
|
memTribCode | string | ||
|
Tipo de Membro
|
memberType | string | ||
|
Próxima Data de Instalação
|
nextInstallDate | date | ||
|
Observação
|
note | string | ||
|
Nota 2
|
note2 | string | ||
|
Object
|
object | string | ||
|
Código da organização
|
orgCode | string | ||
|
Número Trans de origem
|
originatingTransNum | integer | ||
|
Outro código
|
otherCode | string | ||
|
Outra ID
|
otherId | string | ||
|
Método Pay
|
payMethod | string | ||
|
Código do produto
|
productCode | string | ||
|
Quantidade
|
quantity | double | ||
|
Solicitação recorrente
|
recurringRequest | boolean | ||
|
ID do advogado
|
solicitorId | string | ||
|
Código-fonte
|
sourceCode | string | ||
|
Sistema de origem
|
sourceSystem | string | ||
|
Código de status
|
statusCode | string | ||
|
Valor tributável
|
taxableValue | double | ||
|
Data do Thru
|
thruDate | date | ||
|
Data do tique-taque
|
ticklerDate | date | ||
|
Data da Transação
|
transactionDate | date | ||
|
UF1
|
uF1 | string |
Campo de usuário 1 (cadeia de caracteres) |
|
|
UF2
|
uF2 | string |
Campo de usuário 2 (cadeia de caracteres) |
|
|
UF3
|
uF3 | string |
Campo de usuário 3 (cadeia de caracteres) |
|
|
UF4
|
uF4 | double |
Campo de Usuário 4 (Decimal) |
|
|
UF5
|
uF5 | double |
Campo de Usuário 5 (Decimal) |
|
|
UF6
|
uF6 | date |
Campo de Usuário 6 (Data) |
|
|
UF7
|
uF7 | date |
Campo de Usuário 7 (Data) |
|
|
Unidades
|
units | double |
Retornos
- Corpo
- ActivityDTO
Criar uma organização
Cria um registro de contato (organização) no iMIS.
Parâmetros
| Nome | Chave | Obrigatório | Tipo | Description |
|---|---|---|---|---|
|
Nome da Organização
|
organizationName | string |
O nome desta organização |
|
|
URL do site
|
websiteUrl | string |
A URL do site para a home page desta organização |
|
|
Email
|
string |
O endereço de email principal da organização |
||
|
Telefone De Trabalho
|
workPhone | string |
Número de telefone de trabalho da organização |
|
|
Fac-símile
|
fax | string |
O número de fax da organização |
|
|
Tipo de Membro
|
memberType | string |
Código de tipo de membro da organização (por exemplo, "NM" ou "WEB") |
|
|
Categoria de cobrança
|
billingCategory | string |
Nome da categoria de cobrança da organização |
|
|
Chave Principal
|
majorKey | string |
O principal campo de chave da organização |
|
|
Situação
|
status | string |
Código de status da organização (por exemplo, "A", "D", "X") |
|
|
Data de ingresso
|
joinDate | date |
Data de ingresso da organização |
Retornos
- Corpo
- ContactDTO
Excluir um registro de painel de instância única
Exclui um registro de painel de instância única no iMIS.
Parâmetros
| Nome | Chave | Obrigatório | Tipo | Description |
|---|---|---|---|---|
|
Nome do painel
|
panelNameSingleDelete | string |
O nome do painel do qual excluir. |
|
|
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
| Nome | Chave | Obrigatório | Tipo | Description |
|---|---|---|---|---|
|
Nome do painel
|
panelNameMultiDelete | string |
O nome do painel do qual excluir. |
|
|
body
|
body | dynamic |
Esquema gerado por GetPanelDeleteSchema. |
Executar uma IQA
Executa uma IQA iMIS no caminho fornecido.
Parâmetros
| Nome | Chave | Obrigatório | Tipo | Description |
|---|---|---|---|---|
|
Caminho IQA
|
iqaPath | string |
O caminho da IQA a ser executada. |
|
|
body
|
body | dynamic |
Filtros de Iqa. |
Retornos
Localizar atividades
Pesquisar atividades por tipo, ID do iMIS e muito mais
Parâmetros
| Nome | Chave | Obrigatório | Tipo | Description |
|---|---|---|---|---|
|
Tipo de atividade
|
activityType | string |
O código do tipo de atividade |
|
|
ID do iMIS
|
imisId | string |
A ID do iMIS |
|
|
Código do produto
|
productCode | string |
O código do produto |
|
|
Categoria
|
category | string |
A categoria |
|
|
Data da Transação Ativada ou Anterior
|
transactionDateBefore | date |
Data da transação em ou antes |
|
|
Data da transação após
|
transactionDateAfter | date |
Data da transação após |
|
|
Data efetiva em ou antes
|
effectiveDateBefore | date |
Data de efetivação em ou antes |
|
|
Data de efetivação após
|
effectiveDateAfter | date |
Data de efetivação após |
|
|
Data por meio de data ativada ou anterior
|
thruDateBefore | date |
Data do thru em ou antes |
|
|
Data por meio da data após
|
thruDateAfter | date |
Data do thru após |
|
|
Classificar Por
|
sortBy | string |
O nome da propriedade a ser classificada por |
|
|
Classificação decrescente
|
sortDesc | boolean |
Se a ordem de classificação deve estar decrescente (o padrão é crescente) |
Retornos
- Corpo
- ActivityListDTO
Localizar contatos
Localiza registros de contato do iMIS por vários critérios. A maioria dos campos de pesquisa dá suporte a filtros de pesquisa, como "startsWith:x" ou "contains:x". Consulte a documentação para obter uma lista completa.
Parâmetros
| Nome | Chave | Obrigatório | Tipo | Description |
|---|---|---|---|---|
|
Primeiro Nome
|
firstName | string |
Nome do contato (dá suporte a filtros) |
|
|
Apelido
|
lastName | string |
Sobrenome do contato (dá suporte a filtros) |
|
|
Nome Completo
|
fullName | string |
Nome completo do contato (dá suporte a filtros) |
|
|
Email Primário
|
string |
Endereço de email primário do contato (dá suporte a filtros) |
||
|
Código de tipo de membro
|
memberType | string |
Código de tipo de membro do contato (dá suporte a filtros) |
|
|
Nome da Empresa
|
organization | string |
Nome da organização do contato (dá suporte a filtros) |
|
|
Tipos de registro de filtro
|
recordType | string |
Tipos de registro de filtro (pessoas, organizações) |
|
|
Filtrar Status Excluído
|
deleteType | string |
Filtrar o status excluído (marcado para exclusão) |
Retornos
- Corpo
- ContactListDTO
Localizar registros do painel
Localiza registros de painel iMIS por vários critérios. A maioria dos campos de pesquisa dá suporte a filtros de pesquisa, como "startsWith:x" ou "contains:x". Consulte a documentação para obter uma lista completa.
Parâmetros
| Nome | Chave | Obrigatório | Tipo | Description |
|---|---|---|---|---|
|
Nome do painel
|
panelNameFindPost | string |
O nome do painel a ser consultado. |
|
|
body
|
body | dynamic |
Esquema gerado por GetPanelSchema. |
Retornos
Obter a imagem de um contato
Recupera a imagem de perfil de um contato pela ID do iMIS.
Parâmetros
| Nome | Chave | Obrigatório | Tipo | Description |
|---|---|---|---|---|
|
ID do iMIS
|
contactId | True | string |
ID do iMIS |
Retornos
Representa a imagem de perfil de um contato
- Corpo
- ContactPictureDTO
Obter todos os endereços para um contato
Recupera uma lista de endereços para um contato.
Parâmetros
| Nome | Chave | Obrigatório | Tipo | Description |
|---|---|---|---|---|
|
ID do iMIS
|
contactId | True | string |
A ID do iMIS para obter os endereços para |
Retornos
- Corpo
- AddressListDTO
Obter um contato
Recupera um único registro de contato pela ID do iMIS.
Parâmetros
| Nome | Chave | Obrigatório | Tipo | Description |
|---|---|---|---|---|
|
ID do iMIS
|
contactId | True | string |
ID do iMIS |
Retornos
- Corpo
- ContactDTO
Obter um endereço para um contato
Recupera um endereço para um contato.
Parâmetros
| Nome | Chave | Obrigatório | Tipo | Description |
|---|---|---|---|---|
|
ID do iMIS
|
contactId | True | string |
A ID do 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 |
Retornos
- Corpo
- AddressDTO
Obter um registro de painel de instância única
Obtém um registro de painel de instância única no iMIS.
Parâmetros
| Nome | Chave | Obrigatório | Tipo | Description |
|---|---|---|---|---|
|
Nome do painel
|
panelNameSingleGet | string |
O nome do painel do qual recuperar. |
|
|
body
|
body | dynamic |
Esquema gerado por GetPanelGetSchema. |
Retornos
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
| Nome | Chave | Obrigatório | Tipo | Description |
|---|---|---|---|---|
|
Nome do painel
|
panelNameMultiGet | string |
O nome do painel do qual recuperar. |
|
|
body
|
body | dynamic |
Esquema gerado por GetPanelGetSchema. |
Retornos
Obter uma atividade por sequência
Busca um único registro de atividade por seu valor SEQN (sequência)
Parâmetros
| Nome | Chave | Obrigatório | Tipo | Description |
|---|---|---|---|---|
|
Número da sequência
|
sequenceNumber | True | integer |
Número de sequência |
Retornos
- Corpo
- ActivityDTO
Gatilhos
| Quando um pedido é adicionado |
Quando um pedido é adicionado |
| Quando uma atividade é adicionada |
Quando uma atividade é adicionada |
Quando um pedido é adicionado
Quando uma atividade é adicionada
Definições
ActivityDTO
| Nome | Caminho | Tipo | Description |
|---|---|---|---|
|
Códigos de ação
|
actionCodes | string | |
|
Tipo de atividade
|
activityType | string | |
|
Quantidade
|
amount | double | |
|
Sequência de anexos
|
attachSeqn | integer | |
|
Total de Anexos
|
attachTotal | double | |
|
Número do Lote
|
batchNum | string | |
|
Código de campanha
|
campaignCode | string | |
|
Categoria
|
category | string | |
|
Co-ID
|
coId | string | |
|
Description
|
description | string | |
|
Data de Vigência
|
effectiveDate | date | |
|
Período de carência
|
gracePeriod | integer | |
|
ID do iMIS
|
id | string | |
|
Intenção de editar
|
intentToEdit | string | |
|
Código memorial/tributo
|
memTribCode | string | |
|
Tipo de Membro
|
memberType | string | |
|
Próxima Data de Instalação
|
nextInstallDate | date | |
|
Observação
|
note | string | |
|
Nota 2
|
note2 | string | |
|
Object
|
object | string | |
|
Código da organização
|
orgCode | string | |
|
Número Trans de origem
|
originatingTransNum | integer | |
|
Outro código
|
otherCode | string | |
|
Outra ID
|
otherId | string | |
|
Método Pay
|
payMethod | string | |
|
Código do produto
|
productCode | string | |
|
Quantidade
|
quantity | double | |
|
Solicitação recorrente
|
recurringRequest | boolean | |
|
ID do advogado
|
solicitorId | string | |
|
Código-fonte
|
sourceCode | string | |
|
Sistema de origem
|
sourceSystem | string | |
|
Código de status
|
statusCode | string | |
|
Valor tributável
|
taxableValue | double | |
|
Data do Thru
|
thruDate | date | |
|
Data do tique-taque
|
ticklerDate | date | |
|
Data da Transação
|
transactionDate | date | |
|
UF1
|
uF1 | string |
Campo de usuário 1 (cadeia de caracteres) |
|
UF2
|
uF2 | string |
Campo de usuário 2 (cadeia de caracteres) |
|
UF3
|
uF3 | string |
Campo de usuário 3 (cadeia de caracteres) |
|
UF4
|
uF4 | double |
Campo de Usuário 4 (Decimal) |
|
UF5
|
uF5 | double |
Campo de Usuário 5 (Decimal) |
|
UF6
|
uF6 | date |
Campo de Usuário 6 (Data) |
|
UF7
|
uF7 | date |
Campo de Usuário 7 (Data) |
|
Unidades
|
units | double | |
|
Sequence
|
seqn | integer |
O valor da sequência da atividade (chave primária) |
ActivityListDTO
| Nome | Caminho | Tipo | Description |
|---|---|---|---|
|
Lista de atividades
|
value | array of ActivityDTO |
A lista de registros de atividades |
AddressDTO
| Nome | Caminho | Tipo | Description |
|---|---|---|---|
|
ID do endereço
|
addressId | string |
ID exclusiva para este registro de endereço. |
|
Linhas de endereço
|
addressLines | string |
Linhas de rua de endereço separadas por nova linha. |
|
Nome da Cidade
|
city | string |
Nome da cidade no endereço. |
|
Código de estado/província
|
stateProvinceCode | string |
Código abreviado para o estado/província. |
|
Código postal
|
postalCode | string |
CeP ou CEP. |
|
Código do país
|
countryCode | string |
Código de país abreviado. |
|
Número de Telefone
|
phone | string |
Número de telefone formatado para esse endereço. |
|
Endereço eletrônico
|
string |
Email 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 computado completo 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. |
AddressListDTO
| Nome | Caminho | Tipo | Description |
|---|---|---|---|
|
Lista de endereços
|
addresses | array of AddressDTO |
A lista de objetos de endereço para o contato especificado |
ContactDTO
| Nome | Caminho | Tipo | Description |
|---|---|---|---|
|
Tipo de contato
|
contactType | string |
O tipo de contato (organização ou pessoa) |
|
ID do iMIS
|
id | string |
A ID do iMIS (também conhecida como: ID de contato, ID da parte) |
|
Nome
|
name | string |
O nome completo da pessoa computada, ou nome da organização, do contato |
|
Prefixo de nome
|
namePrefix | string |
Prefixo de nome do contato (por exemplo, "Sra.") |
|
Primeiro Nome
|
firstName | string |
O nome do contato |
|
Nome informal
|
informalName | string |
Nome informal do contato (ou apelido) |
|
Nome do Meio
|
middleName | string |
O nome do meio do contato |
|
Apelido
|
lastName | string |
O sobrenome do contato |
|
Sufixo de nome
|
nameSuffix | string |
Sufixo de nome do contato (por exemplo, "Jr.") |
|
Título Funcional
|
functionalTitle | string |
O título funcional do contato, incluindo quaisquer designações |
|
É Membro
|
isMember | boolean |
Sinalizador que especifica se esse contato é um membro da organização |
|
Está ativo
|
isActive | boolean |
Sinalizador que especifica se esse 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 a ID da organização pai vinculada |
|
Email
|
string |
O endereço de email principal do contato |
|
|
Telefone De Trabalho
|
workPhone | string |
O número de telefone do trabalho do contato |
|
Telefone Residencial
|
homePhone | string |
O número de telefone da casa do contato |
|
Celular
|
mobilePhone | string |
O número de telefone celular do contato |
|
Fac-símile
|
fax | string |
O número de fax do contato |
|
Gênero
|
gender | string |
O código de gênero do contato (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 cobrança
|
billingCategory | string |
O nome da categoria de cobrança do contato |
|
Chave Principal
|
majorKey | string |
O campo de chave principal do contato |
|
Situação
|
status | string |
O código de status do contato (por exemplo, "A", "D", "X") |
|
Chave de contato
|
contactKey | string |
A chave do contato, às vezes conhecida como "ID da Rede" (um Guid) |
|
Data de nascimento
|
birthDate | date |
A data de nascimento do contato |
|
Data de ingresso
|
joinDate | date |
A data de ingresso do contato |
|
Thru Pago
|
paidThruDate | date |
A associação do contato paga até a data (se um membro) |
|
Thru renovado
|
renewedThruDate | date |
A data de renovação do contato |
ContactListDTO
| Nome | Caminho | Tipo | Description |
|---|---|---|---|
|
Lista de contatos
|
value | array of ContactDTO |
A lista de registros de contato |
ContactPictureDTO
Representa a imagem de perfil de um contato
| Nome | Caminho | Tipo | Description |
|---|---|---|---|
|
ID do iMIS
|
id | string |
A ID do iMIS associada a esta imagem |
|
Dados de imagem
|
pictureData | byte |
Os dados da imagem |
OrderDTO
| Nome | Caminho | Tipo | Description |
|---|---|---|---|
|
Enviar para a Linha de Endereço 1
|
address1 | string | |
|
Enviar para a Linha de Endereço 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 | |
|
ID de Cobrança para iMIS
|
billToId | string | |
|
Enviar para Endereçar Cidade
|
city | string | |
|
ID do 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 o endereço de email
|
string | ||
|
Valor do Frete 1
|
freight1 | double | |
|
Quantidade de Frete 2
|
freight2 | double | |
|
Enviar para o endereço completo
|
fullAddress | string | |
|
Enviar para o nome completo
|
fullName | string | |
|
Manipulando 1 valor
|
handling1 | double | |
|
Manipulando a quantidade 2
|
handling2 | double | |
|
Manter código
|
holdCode | string | |
|
Manter Comentário
|
holdComment | string | |
|
Está retido?
|
holdFlag | boolean | |
|
Número de referência da fatura
|
invoiceReferenceNumber | integer | |
|
Tipo de envio para membro
|
memberType | string | |
|
Anotações do pedido
|
notes | string | |
|
Data do pedido
|
orderDate | date | |
|
Número do Pedido
|
orderNumber | double | |
|
Código de tipo de pedido
|
orderTypeCode | string | |
|
Código de entidade
|
entityCode | string | |
|
Tipo de pagamento
|
payType | string | |
|
Enviar para o telefone
|
phone | string | |
|
Código-fonte
|
sourceCode | string | |
|
Enviar para a ID do iMIS
|
shipToId | string | |
|
Estágio do Pedido
|
stage | string | |
|
Enviar para Estado/Província
|
stateProvince | string | |
|
Status do pedido
|
status | string | |
|
Valor do Imposto 1
|
tax1 | double | |
|
Valor do Imposto 2
|
tax2 | double | |
|
Valor do Imposto 3
|
tax3 | double | |
|
Taxa de Imposto 1
|
taxRate1 | double | |
|
Taxa de Imposto 2
|
taxRate2 | double | |
|
Taxa de Imposto 3
|
taxRate3 | double | |
|
Título do Pedido
|
title | string | |
|
Encargos totais de pedidos
|
totalCharges | double | |
|
Pedido total de pagamentos
|
totalPayments | double | |
|
Quantidade Total Desordenada
|
totalQuantityBackordered | integer | |
|
Quantidade Total Ordenada
|
totalQuantityOrdered | integer | |
|
Enviar para o Cep
|
zip | string | |
|
Sistema de origem
|
sourceSystem | string | |
|
Código de desconto
|
discountCode | string | |
|
Código tributário do IVA
|
vatTaxCodeFh | string | |
|
Total não contado
|
undiscountedTotal | double | |
|
Código de termos
|
termsCode | string | |
|
Taxa de Imposto
|
taxRateFh | double | |
|
Autor do Imposto 1
|
taxAuthor1 | string | |
|
Autor do Imposto 2
|
taxAuthor2 | string | |
|
Autor do Imposto 3
|
taxAuthor3 | string | |
|
Isenção de impostos
|
taxExempt | string | |
|
Afeta o inventário?
|
affectInventory | boolean | |
|
Valor do imposto sobre o frete
|
freightTax | double | |
|
Manipulando o 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 de envio de documentos
|
shipPapersDateTime | date | |
|
Data do Envio
|
shippedDateTime | date | |
|
Peso Total
|
totalWeight | double | |
|
Inserido por
|
enteredBy | string | |
|
Data/Hora Inseridas
|
enteredDateTime | date |
OrderListDTO
| Nome | Caminho | Tipo | Description |
|---|---|---|---|
|
Lista de pedidos
|
value | array of OrderDTO |
A lista de registros de pedidos |