Soft1

O conector Soft1 fornece uma API para trabalhar com objetos Soft1

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

Serviço	Class	Regiões
Estúdio Copiloto	Standard	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	Standard	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	Standard	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	Constantino Elias
Email	cfe@softone.gr

Metadados do conector
Editora	SoftOne Tecnologias S.A
Sítio Web	https://www.softone.gr
Política de privacidade	https://www.softone.gr/privacy-policy/
Categorias	Gestão Empresarial; Vendas e CRM

O Conector Soft1 fornece uma API para trabalhar com objetos Soft1, a fim de criar fluxos de trabalho automatizados entre aplicativos Soft1 e nossos aplicativos e serviços favoritos.

Pré-requisitos

Para usar essa integração, você precisará acessar uma instalação Soft1 com o módulo Soft1 Microsoft Power Connector habilitado. Para estabelecer uma ligação, selecione Iniciar sessão. Ser-lhe-á pedido que forneça o seu número de série Soft1, nome de utilizador e palavra-passe. Depois que a conexão for criada, você estará pronto para começar a usar essa integração.

Como obter credenciais

Para obter credenciais, uma conta da Web deve ser configurada com acesso ao módulo Soft1 Microsoft Power Connector - esta conta (nome de usuário e senha) e seu número de série de instalação serão usados para autenticação pelo conector Soft1.

Introdução ao conector

Soft1 Connector fornece quatro gatilhos:

* When a record is created or modified
* When a record is deleted
* When a record is modified
* When a record is created

Cada gatilho retorna uma chave (id) do objeto especificado que foi criado, modificado ou excluído, mas não seus dados. Para buscar os dados deste objeto você tem que usar o correspondente Get Action preenchendo o campo "KEY" com a chave retornada pelo gatilho. Por exemplo, quando um novo cliente é inserido no Soft1, nosso gatilho "Quando um registro é criado" retorna a chave do novo registro e, em seguida, a ação "Obter cliente" retorna os dados do cliente.

Limites de Limitação

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

Ações

Adquirir Item	Retorna todos os dados (ou os selecionados de LOCATEINFO) de um registro de um objeto Item.
Inserir chave remota	Inserir ID de aplicativo de terceiros em um objeto Soft1
Inserir ou alterar cheque	Inserir ou Modificar os dados de um Objeto de Cheque identificado por uma CHAVE (ID do Cheque). Se a CHAVE estiver vazia ou em falta é inserido um registo.os dados de um registo num Objeto de Cheque identificado por uma CHAVE. Se a CHAVE estiver vazia ou faltando, um registro será inserido.
Inserir ou modificar contato	Insira ou modifique os dados de um objeto de contato identificado por uma CHAVE (ID de contato) . Se a CHAVE estiver vazia ou faltando, um registro será inserido.
Inserir ou modificar despesas	Insira ou modifique os dados de um objeto de despesa identificado por uma CHAVE (ID de despesa) . Se a CHAVE estiver vazia ou faltando, um registro será inserido.os dados de um registro em um objeto de despesa identificado por uma CHAVE. Se a CHAVE estiver vazia ou faltando, um registro será inserido.
Inserir ou modificar documento de coleções	Inserir ou modificar os dados de um objeto de documento de coleções identificado por uma CHAVE (ID do documento) . Se a CHAVE estiver vazia ou faltando, um registro será inserido.
Inserir ou modificar documento de compras	Inserir ou modificar os dados de um objeto de documento de compra identificado por uma CHAVE (ID do documento) . Se a CHAVE estiver vazia ou faltando, um registro será inserido.
Inserir ou modificar documento de despesas	Inserir ou modificar os dados de um objeto de documento de despesas identificado por uma CHAVE (ID do documento) . Se a CHAVE estiver vazia ou faltando, um registro será inserido.
Inserir ou modificar documento de estoque	Insira ou modifique os dados de um registro de documento de estoque, identificado por uma CHAVE. Se a CHAVE estiver vazia ou ausente, um novo registro será criado
Inserir ou modificar documento de pagamentos	Inserir ou modificar os dados de um objeto de documento de pagamentos identificado por uma CHAVE (ID do documento) . Se a CHAVE estiver vazia ou faltando, um registro será inserido.
Inserir ou modificar documento de vendas	Insira ou modifique os dados de um registro de documento de vendas, identificado por uma CHAVE. Se a CHAVE estiver vazia ou ausente, um novo registro será criado
Inserir ou modificar e-mail	Insira ou modifique os dados de um objeto de e-mail identificado por uma CHAVE (ID de e-mail). Se a CHAVE estiver vazia ou faltando, um registro será inserido.
Inserir ou modificar entrada de rascunho	Inserir ou modificar os dados de um objeto de entrada de rascunho identificado por uma CHAVE (ID de entrada de rascunho) . Se a CHAVE estiver vazia ou faltando, um registro será inserido.
Inserir ou modificar fornecedor	Insira ou modifique os dados de um objeto de fornecedor identificado por uma CHAVE (ID do fornecedor). Se a CHAVE estiver vazia ou faltando, um registro será inserido.
Inserir ou modificar item	Inserir ou modificar os dados de um objeto de item identificado por uma CHAVE (ID do item) . Se a CHAVE estiver vazia ou faltando um registro é inserido.he dados de um registro em um objeto item identificado por uma chave. Se a CHAVE estiver vazia ou faltando, um registro será inserido.
Inserir ou modificar o cliente	Inserir ou modificar os dados de um objeto do cliente identificado por uma CHAVE (ID do cliente) . Se a CHAVE estiver vazia ou faltando, um registro será inserido.
Inserir ou modificar o serviço	Inserir ou modificar os dados de um objeto de serviço identificado por uma CHAVE (ID de serviço) . Se a CHAVE estiver vazia ou faltando, um registro será inserido.
Inserir ou modificar projeto	Insira ou modifique os dados de um objeto de projeto identificado por uma CHAVE (ID do projeto) . Se a CHAVE estiver vazia ou faltando, um registro será inserido.
Inserir ou modificar reunião	Insira ou modifique os dados de um objeto de reunião identificado por uma CHAVE (ID de reunião) . Se a CHAVE estiver vazia ou faltando, um registro será inserido.
Inserir ou modificar tarefa	Insira ou modifique os dados de um objeto de tarefa identificado por uma CHAVE (ID da tarefa) . Se a CHAVE estiver vazia ou faltando, um registro será inserido.
Microsserviço	Faz uma chamada para um microsserviço Soft1. Insira o corpo da solicitação e o ponto de extremidade do serviço Web.
Obter cheque	Devolve todos os dados (ou os dados selecionados de LOCATEINFO) de um registo de um objeto de cheque
Obter Cliente	Retorna todos os dados (ou os selecionados de LOCATEINFO) de um registro de um objeto do cliente.
Obter contato	Retorna todos os dados (ou os selecionados de LOCATEINFO) de um registro de um objeto de contato
Obter Despesas	Retorna todos os dados (ou os selecionados de LOCATEINFO) de um registro de um objeto Expense.
Obter documento de coleções	Retorna todos os dados (ou os selecionados de LOCATEINFO) de um registro de um objeto Collections.
Obter documento de compras	Retorna todos os dados (ou os selecionados de LOCATEINFO) de um registro de um objeto de compra.
Obter Documento de Despesas	Retorna todos os dados (ou os selecionados de LOCATEINFO) de um registro de um objeto de despesas.
Obter documento de estoque	Retorna todos os dados (ou os selecionados de LOCATEINFO) de um registro de um objeto de documento de estoque.
Obter documento de pagamentos	Retorna todos os dados (ou os selecionados de LOCATEINFO) de um registro de um Objeto de Pagamento.
Obter documento de vendas	Retorna todos os dados (ou os selecionados de LOCATEINFO) de um registro de um objeto Sales.
Obter entrada de rascunho	Retorna todos os dados (ou os selecionados de LOCATEINFO) de um registro de um objeto de entrada Rascunho
Obter Fornecedor	Retorna todos os dados (ou os selecionados de LOCATEINFO) de um registro de um objeto de fornecedor.
Obter parâmetros do sistema	Retorna parâmetros da instalação
Obter projeto	Retorna todos os dados (ou os selecionados de LOCATEINFO) de um registro de um objeto de projeto
Obter reunião	Retorna todos os dados (ou os selecionados de LOCATEINFO) de um registro de um objeto de reunião.
Obter serviços	Retorna todos os dados (ou os selecionados de LOCATEINFO) de um registro de um objeto de serviço.
Obter tarefa	Retorna todos os dados (ou os selecionados de LOCATEINFO) de um registro de um objeto de tarefa.
Receber e-mail	Retorna todos os dados (ou os selecionados de LOCATEINFO) de um registro de um objeto de e-mail

Adquirir Item

ID da Operação:

GetItem

Retorna todos os dados (ou os selecionados de LOCATEINFO) de um registro de um objeto Item.

Parâmetros

Name	Chave	Necessário	Tipo	Description
FORMULÁRIO	FORM		string	Especificar formulário do item
CHAVE	KEY	True	string	Inserir um ID de registo de item válido
LOCALIZARINFO	LOCATEINFO	True	string	Especificar os campos desejados do item

Devoluções

Name	Caminho	Tipo	Description
Legenda	caption	string	Legenda descritiva do registo do item
Chave remota	remoteKey	string	ID do aplicativo de terceiros
código	data.ITEM.CODE	string	O código do item
Active	data.ITEM.ISACTIVE	string	O item está ativo?
categoria comercial	data.ITEM.MTRCATEGORY	string	A categoria comercial do artigo
Grupo de itens	data.ITEM.MTRGROUP	string	O grupo do item
Unidade de medida base	data.ITEM.MTRUNIT1	string	Unidade de medida base do item
descrição	data.ITEM.NAME	string	O nome do item
Preço de Venda ao Público	data.ITEM.PRICER	string	Preço de venda ao público do artigo
preço por grosso	data.ITEM.PRICEW	string	Preço grossista do artigo
comments	data.ITEM.REMARKS	string	Comentários do item
desconto (%)	data.ITEM.SODISCOUNT	string	O desconto do artigo
Grupo IVA	data.ITEM.VAT	string	Imposto sobre o Valor Acrescentado do item
Erro	error	string	Mensagem de erro se a ação não for bem-sucedida
Código de erro	errorcode	integer	Código de erro se a ação não for bem-sucedida
Sucesso	success	boolean	A ação é bem-sucedida?

Inserir chave remota

ID da Operação:

SetRemoteKey

Inserir ID de aplicativo de terceiros em um objeto Soft1

Parâmetros

Name	Chave	Necessário	Tipo	Description
CHAVE	KEY	True	string	Insira um ID de objeto Soft1 válido
Chave remota	REFID	True	string	Insira um ID de aplicativo de terceiros válido
Objeto Soft1	SOSOURCE	True	string	Selecionar objeto Soft1

Devoluções

Body

setData200response

Inserir ou alterar cheque

ID da Operação:

SetCheque

Inserir ou Modificar os dados de um Objeto de Cheque identificado por uma CHAVE (ID do Cheque). Se a CHAVE estiver vazia ou em falta é inserido um registo.os dados de um registo num Objeto de Cheque identificado por uma CHAVE. Se a CHAVE estiver vazia ou faltando, um registro será inserido.

Parâmetros

Name	Chave	Necessário	Tipo	Description
FORMULÁRIO	FORM		string	Especificar o formulário do cheque
CHAVE	KEY		string	Insira um ID de registro de cheque válido para modificá-lo
Banco	BANK		string	Selecione o banco ou insira o ID do banco
Equilíbrio	CHEQUEBAL	True	string	Especificar o saldo do cheque
Número do cheque	CHEQUENUMBER	True	string	Inserir número do cheque
Situação	CHEQUESTATES	True	string	Selecione o estado do cheque ou introduza o ID do estado
Valor	CHEQUEVAL	True	string	Especificar o valor do cheque
Endereço do emitente	CREATORADDR		string	Especificar o endereço do emitente
Nome do emissor	CREATORNAME		string	Especificar o nome do emitente
Telefone do emissor	CREATORPHONE		string	Especificar o telefone do emissor
Data do recibo	CRTDATE		string	Especifique a data de receção do cheque no formato AAAA-MM-DD ou deixe-a em branco para hoje
Data de emissão	DATEOFS	True	string	Especifique a data de emissão do cheque no formato AAAA-MM-DD ou deixe-a em branco para hoje
Data de vencimento	FINALDATE	True	date-time	Especifique a data de vencimento do cheque no formato AAAA-MM-DD ou deixe-a em branco para hoje
Endereço do titular	HOLDERADDR		string	Especificar a morada do titular do cheque
Nome do titular	HOLDERNAME		string	Especificar o nome do titular do cheque
Emitente T.R.No	PUBLISHERAFM		string	Especifique o número de identificação fiscal do emissor
Comments	REMARKS		string	Inserir comentários
Series	SERIES	True	string	Inserir um código de cheque

Devoluções

Body

setData200response

Inserir ou modificar contato

ID da Operação:

SetContact

Insira ou modifique os dados de um objeto de contato identificado por uma CHAVE (ID de contato) . Se a CHAVE estiver vazia ou faltando, um registro será inserido.

Parâmetros

Name	Chave	Necessário	Tipo	Description
FORMULÁRIO	FORM		string	Especificar formulário de contacto
CHAVE	KEY		string	Insira um ID de contato válido para modificá-lo
Address	ADDRESS		string	Especifique o endereço do contato
T.R.No	AFM		string	Especifique o Número de Identificação Fiscal do contacto
Áreas Geográficas	AREAS		string	Selecione a área geográfica
Data de nascimento	BIRTHDATE		date-time	Especifique a data de nascimento do contacto no formato AAAA-MM-DD ou deixe-a em branco para hoje
City	CITY		string	Especifique a cidade do contacto
Código	CODE	True	string	Inserir um código de contacto
Country	COUNTRY		string	Selecione o país ou insira o ID do país
Area	DISTRICT		string	Especificar a área do contacto
Prefeitura	DISTRICT1		string	Especifique a prefeitura do contato
Nível de escolaridade	EDUCAT		string	Selecione o nível de escolaridade do contacto
Email	EMAIL		string	Especifique o e-mail do contato
E-mail 2	EMAIL1		string	Especifique o segundo e-mail do contato
Fax	FAX		string	Especifique o número de fax do contacto
N.º do Bilhete de Identidade	IDENTITYNUM		string	Especifique o número do cartão de identificação do contacto
Repartição de Finanças	IRSDATA		string	Selecione a repartição fiscal do contacto
Telemóvel	MOBILEPHONE		string	Especifique o número de telemóvel do contacto
Nome	NAME	True	string	Especifique o nome do contato
Surname	NAME2		string	Especifique o apelido do contacto
Nome do pai	NAME3		string	Especifique o nome do pai do contato
Nome da mãe	NAME4		string	Especifique o nome da mãe do contato
Nome do cônjuge	NAME5		string	Especifique o nome do cônjuge do contacto
Nationality	NATIONALITY		string	Selecione a nacionalidade ou insira o ID de nacionalidade
Telefone. 1	PHONE1		string	Especifique o primeiro número de telefone do contato
Telefone. 2	PHONE2		string	Especificar o segundo número de telefone do contacto
Telefone interno	PHONEEXT		string	Especifique o número de telefone interno do contato
Telefone pessoal	PHONELOCAL		string	Especifique o número de telefone pessoal do contacto
Comments	REMARKS		string	Inserir comentários
Sexo	SOSEX		string	Selecione o sexo do contato. «1» para homens e «2» para mulheres
página Web	WEBPAGE		string	Especificar a página Web do contacto
Código Postal	ZIP		string	Especifique o código postal do contacto
linha n.º	LINENUM		string	Especifique a linha nº. da rubrica anexa
nome	NAME		string	Especifique o nome do arquivo do item anexado
URL	SOFNAME		string	Especifique o endereço url do item anexado

Devoluções

Body

setData200response

Inserir ou modificar despesas

ID da Operação:

SetExpense

Insira ou modifique os dados de um objeto de despesa identificado por uma CHAVE (ID de despesa) . Se a CHAVE estiver vazia ou faltando, um registro será inserido.os dados de um registro em um objeto de despesa identificado por uma CHAVE. Se a CHAVE estiver vazia ou faltando, um registro será inserido.

Parâmetros

Name	Chave	Necessário	Tipo	Description
FORMULÁRIO	FORM		string	Especificar formulário de despesa
CHAVE	KEY		string	Insira um ID de registro de despesas válido para modificá-lo
Código	CODE	True	string	Inserir um código de despesa
Categoria de faturação	LISOURCETYPE	True	string	Selecione a categoria de faturação (12 para «Fornecedores», 13 para «Clientes», 14 para «Contas de caixa», 15 para «Devedores», 16 para «Credores»)
Categoria comercial	MTRCATEGORY		string	Especificar a categoria comercial da despesa
Tipo	MTRTYPE		string	Selecione o tipo de despesa (0 para 'Normal', 1 para 'Despesa', 2 para 'Apenas IVA')
Nome	NAME	True	string	Especifique o nome da despesa
Comments	REMARKS		string	Inserir comentários
Valor da taxa	SOPAYVALUE		string	Selecione o valor da taxa (1 para 'Salário Bruto', 2 para 'Deduções', 3 para 'Imposto',4 para 'Selo',5 para 'Selo OGA')
Grupo IVA	VAT	True	string	Selecione o grupo de Imposto sobre Valor Agregado da despesa ou insira o ID do IVA

Devoluções

Body

setData200response

Inserir ou modificar documento de coleções

ID da Operação:

SetCFNCUSDOC

Inserir ou modificar os dados de um objeto de documento de coleções identificado por uma CHAVE (ID do documento) . Se a CHAVE estiver vazia ou faltando, um registro será inserido.

Parâmetros

Name	Chave	Necessário	Tipo	Description
N.º do cartão de crédito	CRDCARDNUM		string	Insira o número do cartão de crédito
Cartão de crédito	CREDITCARDS		integer	Selecione um cartão de crédito ou insira o ID do cartão de crédito
Número da linha de cartão de crédito	LINENUM		integer	Especifique o número da linha do cartão de crédito ou deixe-o em branco por padrão
Valor da linha do cartão	LINEVAL		integer	Especifique o valor da linha do cartão
Linha de numerário n.º	LINENUM		integer	Especifique o número da linha de caixa ou deixe-o em branco por padrão
Valor da linha de caixa	LINEVAL		integer	Especifique o valor da linha de caixa
Collector	COLLECTOR		string	Selecione o Coletor ou insira o ID do Coletor
Reason	COMMENTS		string	Selecione o motivo ou insira o ID do motivo
Projeto	PRJC		string	Selecione o projeto ou insira o ID do projeto
Vendedor	SALESMAN		string	Selecione o Vendedor ou insira o ID do Vendedor
Series	SERIES	True	string	Selecione a Série do documento ou insira o ID da Série
Cliente	TRDR	True	string	Selecione o Cliente ou insira o ID do Cliente
Data da transação	TRNDATE		string	Especifique a data da transação no formato AAAA-MM-DD ou deixe-a em branco para hoje
N.º de cheque	CCHEQUENUMBER		string	Inserir n.º de cheque
Data de vencimento do cheque	CFINALDATE		date-time	Especifique a data de vencimento do cheque com o formato: AAAA-MM-DD ou deixe-a em branco para a data de hoje
Cheque	CODE		string	Inserir código do cheque
Série de cheques	CSERIES		integer	Selecione a série de cheques ou introduza o ID da série de cheques
Número da linha do cheque	LINENUM		integer	Especifique o número da linha do cheque ou deixe-o em branco por defeito
Valor da linha do cheque	LINEVAL		integer	Especificar o valor da linha do cheque
Tipo de operação com cheque	TPRMS		integer	Selecione o tipo de transação ou insira o ID do tipo de transação
FORMULÁRIO	FORM		string	Especificar o formulário do documento
CHAVE	KEY		string	Insira um ID de registro de documento válido para modificá-lo

Devoluções

Body

setData200response

Inserir ou modificar documento de compras

ID da Operação:

SetPurdoc

Inserir ou modificar os dados de um objeto de documento de compra identificado por uma CHAVE (ID do documento) . Se a CHAVE estiver vazia ou faltando, um registro será inserido.

Parâmetros

Name	Chave	Necessário	Tipo	Description
Desconto	DISC1PRC		integer	Especifique o desconto do item
N.º da linha	LINENUM		string	Especifique o número da linha do item ou deixe-o em branco por padrão
Valor da linha	LINEVAL		string	Especificar o valor da linha do item
Item	MTRL		string	Selecione um item ou insira o ID do item
Preço	PRICE		string	Especifique o preço do item
Quantidade	QTY		integer	Especificar a quantidade do artigo
Armazém	WHOUSE	True	string	Selecione o depósito ou insira o ID do depósito
Desconto	DISC1PRC		string	Especifique o desconto do documento
Pagamento	PAYMENT		string	Selecione o método de pagamento ou insira o ID de pagamento
Projeto	PRJC		string	Selecione o projeto ou insira o ID do projeto
Comments	REMARKS		string	Inserir comentários
Series	SERIES	True	string	Selecione a série do documento ou insira o ID da série
Moeda	SOCURRENCY	True	string	Selecione a moeda de pagamento ou insira o ID da moeda
Total	SUMAMNT		string	Especificar o valor total do documento
Fornecedor	TRDR	True	string	Selecione o fornecedor ou insira o ID do fornecedor
Data da transação	TRNDATE		string	Especifique a data da transação no formato AAAA-MM-DD ou deixe-a em branco para hoje
Desconto	DISC1PRC		integer	Especifique o desconto do serviço
N.º da linha	LINENUM		string	Especifique o número da linha do serviço ou deixe-o em branco por padrão
Valor da linha	LINEVAL		string	Especificar o valor da linha do serviço
Serviço	MTRL		string	Selecione um serviço ou insira o ID do serviço
Preço	PRICE		string	Especifique o preço do serviço
Quantidade	QTY		integer	Especificar a quantidade do serviço
FORMULÁRIO	FORM		string	Especificar formulário do documento
CHAVE	KEY		string	Insira um ID de registro de documento válido para modificá-lo

Devoluções

Body

setData200response

Inserir ou modificar documento de despesas

ID da Operação:

SetExpensesDoc

Inserir ou modificar os dados de um objeto de documento de despesas identificado por uma CHAVE (ID do documento) . Se a CHAVE estiver vazia ou faltando, um registro será inserido.

Parâmetros

Name	Chave	Necessário	Tipo	Description
N.º da linha	LINENUM		string	Especifique o número da linha do item ou deixe-o em branco por padrão
Valor da linha	LINEVAL		string	Especifique o valor da linha da despesa
Despesa	MTRL		string	Selecione uma despesa ou insira o ID da despesa
IVA	VAT		string	Selecione IVA ou insira o ID de IVA
Projeto	PRJC		string	Selecione o projeto ou insira o ID do projeto
Comments	REMARKS		string	Inserir comentários
Series	SERIES	True	string	Selecione a Série do documento ou insira o ID da Série
Fornecedor	TRDR	True	string	Selecione o Cliente ou insira o ID do Cliente
Data da transação	TRNDATE		string	Especifique a data da transação no formato AAAA-MM-DD ou deixe-a em branco para hoje
FORMULÁRIO	FORM		string	Especificar formulário do documento
CHAVE	KEY		string	Insira um ID de registro de documento válido para modificá-lo

Devoluções

Body

setData200response

Inserir ou modificar documento de estoque

ID da Operação:

SetItedoc

Insira ou modifique os dados de um registro de documento de estoque, identificado por uma CHAVE. Se a CHAVE estiver vazia ou ausente, um novo registro será criado

Parâmetros

Name	Chave	Necessário	Tipo	Description
FORMULÁRIO	FORM		string	Especificar formulário do documento
CHAVE	KEY		string	Insira um ID de registro de documento válido para modificá-lo
Reason	COMMENTS		string	Especificar o motivo do documento
Comments	REMARKS		string	Inserir comentários
Series	SERIES	True	string	Selecione a Série do documento ou insira o ID da Série
Data da transação	TRNDATE		string	Especifique a data da transação no formato AAAA-MM-DD ou deixe-a em branco para hoje
Desconto	DISC1PRC		string	Especifique o desconto do item
N.º da linha	LINENUM		string	Especifique o número da linha do item ou deixe-o em branco por padrão.
Valor da linha	LINEVAL		string	Especificar o valor da linha do item
Item	MTRL		string	Selecione um item ou insira o ID do item
Preço	PRICE		string	Especifique o preço do item
Quantidade	QTY		string	Especificar a quantidade do artigo
Armazém	WHOUSE	True	string	Selecione o depósito ou insira o ID do depósito

Devoluções

Body

setData200response

Inserir ou modificar documento de pagamentos

ID da Operação:

SetCfnsupdoc

Inserir ou modificar os dados de um objeto de documento de pagamentos identificado por uma CHAVE (ID do documento) . Se a CHAVE estiver vazia ou faltando, um registro será inserido.

Parâmetros

Name	Chave	Necessário	Tipo	Description
N.º do cartão de crédito	CRDCARDNUM		string	Especifique o número do cartão de crédito
Cartão de crédito	CREDITCARDS		integer	Selecione um cartão de crédito ou insira um ID de cartão de crédito
Número da linha de cartão de crédito	LINENUM		integer	Especifique o número da linha do cartão de crédito ou deixe-o em branco por padrão
Valor da linha do cartão	LINEVAL		integer	Especifique o valor da linha do cartão de crédito
Linha de numerário n.º	LINENUM		integer	Especifique o número da linha de caixa ou deixe-o em branco por padrão
Valor da linha de caixa	LINEVAL		integer	Especifique o valor da linha de caixa
Projeto	PRJC		string	Selecione o projeto ou insira o ID do projeto
Comments	REMARKS		string	Inserir comentários
Series	SERIES	True	string	Selecione a série do documento ou insira um ID de série
Fornecedor	TRDR	True	string	Selecione o cliente ou insira o ID do cliente
Data da transação	TRNDATE		string	Especifique a data da transação no formato AAAA-MM-DD ou deixe-a em branco para hoje
N.º de cheque	CCHEQUENUMBER		string	Inserir n.º de cheque
Data de vencimento do cheque	CFINALDATE		date-time	Especifique a data de vencimento do cheque com o formato: AAAA-MM-DD ou deixe-a em branco para a data de hoje
Cheque	CODE		string	Inserir código do cheque
Série de cheques	CSERIES		integer	Selecione a série de cheques ou introduza o ID da série de cheques
Número da linha do cheque	LINENUM		integer	Especifique o número da linha do cheque ou deixe-o em branco por defeito
Valor da linha do cheque	LINEVAL		integer	Especificar o valor da linha do cheque
Tipo de operação com cheque	TPRMS		integer	Selecione o tipo de transação ou insira o ID do tipo de transação
FORMULÁRIO	FORM		string	Especificar formulário do documento
CHAVE	KEY		string	Insira um ID de registro de documento válido para modificá-lo

Devoluções

Body

setData200response

Inserir ou modificar documento de vendas

ID da Operação:

SetSaldoc

Insira ou modifique os dados de um registro de documento de vendas, identificado por uma CHAVE. Se a CHAVE estiver vazia ou ausente, um novo registro será criado

Parâmetros

Name	Chave	Necessário	Tipo	Description
FORMULÁRIO	FORM		string	Especificar formulário do documento
CHAVE	KEY		string	Insira um ID de registro de documento válido para modificá-lo
Desconto	DISC1PRC		string	Especifique o desconto do item
N.º da linha	LINENUM		string	Especifique o número da linha do item ou deixe-o em branco por padrão.
Valor da linha	LINEVAL		string	Especificar o valor da linha do item
Item	MTRL		string	Selecione um item ou insira o ID do item
Preço	PRICE		string	Especifique o preço do item
Quantidade	QTY		string	Especificar a quantidade do artigo
Armazém	WHOUSE	True	string	Selecione o depósito ou insira o ID do depósito
Desconto	DISC1PRC		string	Especifique o desconto do documento
Valor do desconto	DISC1VAL		string	Especifique o valor de desconto do documento
Montante líquido	NETAMNT		string	Especificar o montante líquido do documento
Pagamento	PAYMENT	True	string	Selecione o método de pagamento ou insira o ID de pagamento
Projeto	PRJC		string	Selecione o projeto ou insira o ID do projeto
Comments	REMARKS		string	Inserir comentários
Series	SERIES	True	string	Selecione a Série do documento ou insira o ID da Série
Moeda	SOCURRENCY	True	string	Selecione a moeda de pagamento ou insira o ID da moeda
Total	SUMAMNT		string	Especificar o valor total do documento
Cliente	TRDR	True	string	Selecione o Cliente ou insira o ID do Cliente
Data da transação	TRNDATE		string	Especifique a data da transação no formato AAAA-MM-DD ou deixe-a em branco para hoje
IVA	VATAMNT		string	Especificar o IVA total do documento
Desconto	DISC1PRC		integer	Especifique o desconto do serviço
N.º da linha	LINENUM		string	Especifique o número da linha do serviço ou deixe-o em branco por padrão
Valor da linha	LINEVAL		string	Especificar o valor da linha do serviço
Serviço	MTRL		string	Selecione um serviço ou insira o ID do serviço
Preço	PRICE		string	Especificar o preço do serviço
Quantidade	QTY		integer	Especificar a quantidade do serviço

Devoluções

Body

setData200response

Inserir ou modificar e-mail

ID da Operação:

SetSOEMAIL

Insira ou modifique os dados de um objeto de e-mail identificado por uma CHAVE (ID de e-mail). Se a CHAVE estiver vazia ou faltando, um registro será inserido.

Parâmetros

Name	Chave	Necessário	Tipo	Description
Situação	ACTSTATUS		string	Selecione o status (0 para 'Indiferente', 1 para 'A ser ativado', 2 para 'Em andamento', 3 para 'Concluído', 4 para 'Cancelado', 5 para 'Aguardando', 6 para 'Adiado')
Assunto	COMMENTS		string	Especifique o assunto do e-mail
Series	SERIES	True	string	Selecione a Série do E-mail ou insira o ID da Série
Data do correio	TRNDATE		date-time	Especifique a Data do e-mail no formato AAAA-MM-DD ou deixe-a em branco para hoje
De (Enviar como)	FROMADDRESS		string	Endereço de e-mail a partir do qual enviar e-mails (requer a permissão "Enviar como" ou "Enviar em nome de" para essa caixa de correio)
Remetente	FROMNAME		string	Especifique o proprietário da caixa de correio e o nome do remetente
CBC	SOBCC		string	Especifique endereços de e-mail separados por ponto-e-vírgula, como someone@softone.gr
Body	SOBODY		string	Especificar o corpo do correio
CC	SOCC		string	Especifique endereços de e-mail separados por ponto-e-vírgula, como someone@softone.gr
Para	SOTO		string	Especifique endereços de e-mail separados por ponto-e-vírgula, como someone@softone.gr
linha n.º	LINENUM		string	Especifique a linha nº. da rubrica anexa
nome	NAME		string	Especifique o nome do arquivo do item anexado
URL	SOFNAME		string	Especifique o endereço url do item anexado
FORMULÁRIO	FORM		string	Especifique o formulário do e-mail
CHAVE	KEY		string	Insira um ID de registro de e-mail válido para modificá-lo

Devoluções

Body

setData200response

Inserir ou modificar entrada de rascunho

ID da Operação:

SetDraftEntry

Inserir ou modificar os dados de um objeto de entrada de rascunho identificado por uma CHAVE (ID de entrada de rascunho) . Se a CHAVE estiver vazia ou faltando, um registro será inserido.

Parâmetros

Name	Chave	Necessário	Tipo	Description
FORMULÁRIO	FORM		string	Especificar formulário de entrada de rascunho
CHAVE	KEY		string	Insira um ID de entrada de rascunho válido para modificá-lo
Address	ADDRESS		string	Especificar o endereço da entrada de rascunho
T.R.No	AFM		string	Especifique o número de registro fiscal da entrada de rascunho
City	CITY		string	Especificar a cidade da entrada de rascunho
Código	CODE	True	string	Inserir um código de entrada de rascunho
Country	COUNTRY		string	Especificar o país da entrada de rascunho
Area	DISTRICT		string	Especificar a área da entrada de rascunho
Prefeitura	DISTRICT1		string	Especificar a prefeitura da entrada de rascunho
Categoria	DRAFTTYPE		string	Especificar a categoria da entrada de rascunho
E-mail da empresa	EMAIL		string	Especifique o e-mail da empresa da entrada de rascunho
E-mail comercial	EMAIL1		string	Especificar o e-mail comercial da entrada de rascunho
E-mail pessoal	EMAIL2		string	Especificar o e-mail pessoal da entrada de rascunho
N.º do Bilhete de Identidade	IDENTITYNUM		string	Especifique o número do cartão de identificação da entrada de rascunho
Activity	JOBTYPETRD		string	Especificar a atividade da entrada de rascunho
Telemóvel	MOBILEPHONE		string	Especificar o número de telemóvel da entrada de rascunho
Nome/Título	NAMEC		string	Especificar o nome/título da entrada de rascunho
Nome próprio	NAMEF		string	Especificar o primeiro nome da entrada de rascunho
Surname	NAMEL		string	Especificar o apelido do projeto de entrada
General Com. Reg.	NUMCG		string	Especificar o registo comercial geral do projeto de inscrição
Telefone comercial	PHONE1		string	Especifique o número de telefone comercial da entrada de rascunho
Telefone interno	PHONEEXT		string	Especificar o número de telefone interno da entrada de rascunho
Telefone pessoal	PHONELOCAL		string	Especifique o número de telefone pessoal da entrada de rascunho
Comments	REMARKS		string	Inserir comentários
Title	SOTITLENAME		string	Especificar o título do trabalho da entrada de rascunho
página Web	WEBPAGE		string	Especificar a página Web da entrada de rascunho
Código Postal	ZIP		string	Especifique o código postal da entrada de rascunho
Filial	BRANCH		string	Selecione a ramificação ou insira o ID da filial
Unidade de negócio	BUSUNITS		string	Selecione a unidade de negócios ou insira o ID da unidade de negócios
Departamento	DEPART		string	Selecione o departamento ou insira o ID do departamento
Projeto	PRJC		string	Selecione o projeto ou insira o ID do projeto
Fonte	PRJCLEAD		string	Selecione a fonte ou insira o ID de origem

Devoluções

Body

setData200response

Inserir ou modificar fornecedor

ID da Operação:

SetSupplier

Insira ou modifique os dados de um objeto de fornecedor identificado por uma CHAVE (ID do fornecedor). Se a CHAVE estiver vazia ou faltando, um registro será inserido.

Parâmetros

Name	Chave	Necessário	Tipo	Description
Banco	BANK		string	Selecione um banco
IBAN	IBAN		string	Inserir número de conta bancária internacional
Comentários da conta bancária	REMARKS		string	Inserir comentários para esta conta bancária
Address	ADDRESS		string	Especificar o endereço principal do fornecedor
T.R.No	AFM		string	Especifique o número de registo fiscal do fornecedor
City	CITY		string	Especifique a cidade do fornecedor
Código	CODE	True	string	Inserir um código de fornecedor
Área de localização	DISTRICT		string	Especificar a área de localização do fornecedor
Email	EMAIL		string	Especifique o endereço de e-mail do fornecedor
TELEFAX	FAX		string	Especificar o número de fax do fornecedor
Repartição de Finanças	IRSDATA		string	Selecione a repartição fiscal do fornecedor
Profissão	JOBTYPETRD		string	Especificar a profissão do fornecedor
Nome	NAME	True	string	Especificar o nome do fornecedor
Telefone principal	PHONE01		string	Especifique o número de telefone principal do fornecedor
Comments	REMARKS		string	Inserir comentários
CEP	ZIP		string	Especifique o código postal do fornecedor
FORMULÁRIO	FORM		string	Especificar o formulário do fornecedor
CHAVE	KEY		string	Insira um ID de fornecedor válido para modificá-lo

Devoluções

Body

setData200response

Inserir ou modificar item

ID da Operação:

SetItem

Inserir ou modificar os dados de um objeto de item identificado por uma CHAVE (ID do item) . Se a CHAVE estiver vazia ou faltando um registro é inserido.he dados de um registro em um objeto item identificado por uma chave. Se a CHAVE estiver vazia ou faltando, um registro será inserido.

Parâmetros

Name	Chave	Necessário	Tipo	Description
FORMULÁRIO	FORM		string	Especificar formulário do item
CHAVE	KEY		string	Insira um ID de registro de item válido para modificá-lo
Código	CODE	True	string	Inserir um código de item
Categoria comercial	MTRCATEGORY		string	Especificar a categoria comercial do artigo
Grupo de itens	MTRGROUP		string	Selecione o grupo do item ou insira o ID do grupo do item
Unidade de medida de base	MTRUNIT1	True	string	Selecione o U.o.M do item ou insira o ID U.o.M
Nome	NAME	True	string	Especifique o nome do item
Preço de venda ao cliente	PRICER		string	Especificar o preço de venda ao público do item
Preço por grosso	PRICEW		string	Especificar o preço grossista do artigo
Comments	REMARKS		string	Inserir comentários
Desconto	SODISCOUNT		string	Especifique o desconto do item
Grupo IVA	VAT	True	string	Selecione o grupo de Imposto sobre Valor Agregado do item ou insira o ID do IVA

Devoluções

Body

setData200response

Inserir ou modificar o cliente

ID da Operação:

SetCustomer

Inserir ou modificar os dados de um objeto do cliente identificado por uma CHAVE (ID do cliente) . Se a CHAVE estiver vazia ou faltando, um registro será inserido.

Parâmetros

Name	Chave	Necessário	Tipo	Description
FORMULÁRIO	FORM		string	Especificar formulário do cliente
CHAVE	KEY		string	Insira um ID de cliente válido para modificá-lo
Endereço principal	ADDRESS		string	Especifique o endereço principal do cliente
T.R.No	AFM		string	Especifique o número de registo fiscal do cliente
Áreas Geográficas	AREAS		string	Selecione a área geográfica
City	CITY		string	Especifique a cidade do cliente
Código	CODE	True	string	Inserir um código de cliente
Desconto	DISCOUNT		integer	Especifique o desconto do cliente
Área de Localização	DISTRICT		string	Especificar a área de localização do cliente
correio electrónico	EMAIL		string	Especifique o endereço de e-mail do cliente
Fax	FAX		string	Especifique o número de fax do cliente
Repartição de Finanças	IRSDATA		string	Selecione a repartição fiscal do cliente
Profissão	JOBTYPETRD		string	Especificar a profissão do cliente
Nome	NAME	True	string	Especifique o nome do cliente
Telefone principal	PHONE01		string	Especifique o número de telefone principal do cliente
Comments	REMARKS		string	Inserir comentários
Categoria de Imposto	VATSTS		string	Selecione a categoria de imposto (0 para Isentos, 1 para Normal, 2 para Reduzidos)
Código Postal	ZIP		string	Especifique o código postal do cliente

Devoluções

Body

setData200response

Inserir ou modificar o serviço

ID da Operação:

SetService

Inserir ou modificar os dados de um objeto de serviço identificado por uma CHAVE (ID de serviço) . Se a CHAVE estiver vazia ou faltando, um registro será inserido.

Parâmetros

Name	Chave	Necessário	Tipo	Description
FORMULÁRIO	FORM		string	Especificar formulário do serviço
CHAVE	KEY		string	Insira um ID de registro de serviço válido para modificá-lo
Código	CODE	True	string	Inserir um código de serviço
Categoria comercial	MTRCATEGORY		string	Especificar a categoria comercial do serviço
Grupo de serviços	MTRGROUP		string	Selecione o grupo do serviço ou insira o ID do grupo do serviço
Unidade de medida de base	MTRUNIT1	True	string	Selecione o U.o.M do serviço ou insira o ID U.o.M
Nome	NAME	True	string	Especifique o nome do serviço
Preço de venda ao cliente	PRICER		string	Especificar o preço de venda ao público do serviço
Preço por grosso	PRICEW		string	Especificar o preço grossista do serviço
Comments	REMARKS		string	Inserir comentários
Desconto	SODISCOUNT		string	Especifique o desconto do serviço
Grupo IVA	VAT	True	string	Selecione o grupo de Imposto sobre Valor Agregado do serviço ou insira o ID do IVA

Devoluções

Body

setData200response

Inserir ou modificar projeto

ID da Operação:

SetProject

Insira ou modifique os dados de um objeto de projeto identificado por uma CHAVE (ID do projeto) . Se a CHAVE estiver vazia ou faltando, um registro será inserido.

Parâmetros

Name	Chave	Necessário	Tipo	Description
FORMULÁRIO	FORM		string	Especificar formulário de contacto
CHAVE	KEY		string	Insira um ID de contato válido para modificá-lo
Situação	ACTSTATUS		string	Selecione o status (0 para 'Indiferente', 1 para 'A ser ativado', 2 para 'Em andamento', 3 para 'Concluído', 4 para 'Cancelado', 5 para 'Aguardando', 6 para 'Adiado')
Código	CODE	True	string	Inserir um código de contacto
Data de vencimento	FINALDATE		date-time	Especifique a data de conclusão da tarefa no formato AAAA-MM-DD ou deixe-a em branco para hoje
Data de início	FROMDATE		date-time	Especifique a data em que a tarefa foi criada no formato AAAA-MM-DD ou deixe-a em branco para hoje
Nome	NAME	True	string	Especifique o nome do projeto
Variação	PRJCRM		string	Selecione a variação (0 para 'Projeto', 1 para 'Campanha', 2 para 'Oportunidade')
Comments	REMARKS		string	Inserir comentários
linha n.º	LINENUM		string	Especifique a linha nº. da rubrica anexa
nome	NAME		string	Especifique o nome do arquivo do item anexado
URL	SOFNAME		string	Especifique o endereço url do item anexado

Devoluções

Body

setData200response

Inserir ou modificar reunião

ID da Operação:

SetMeeting

Insira ou modifique os dados de um objeto de reunião identificado por uma CHAVE (ID de reunião) . Se a CHAVE estiver vazia ou faltando, um registro será inserido.

Parâmetros

Name	Chave	Necessário	Tipo	Description
Operator	ACTOR		string	Selecione o operador ou insira o ID do operador
Contacto do operador	ACTPRSN		string	Selecione o contacto do operador ou introduza o ID de contacto
Situação	ACTSTATUS		string	Selecione o status (0 para 'Indiferente', 1 para 'A ser ativado', 2 para 'Em andamento', 3 para 'Concluído', 4 para 'Cancelado', 5 para 'Aguardando', 6 para 'Adiado')
Assunto	COMMENTS		string	Especificar o tema da reunião
Data de vencimento	FINALDATE		date-time	Especifique a data em que a reunião foi criada no formato AAAA-MM-DD ou deixe-a em branco para hoje
Data de início	FROMDATE		date-time	Especifique a data em que a reunião foi criada no formato AAAA-MM-DD ou deixe-a em branco para hoje
Encomendado por	ORDEREDBY		string	Selecione o encomendante ou introduza o ID do encomendante
Encomendado por Contacto	ORDPRSN		string	Selecione o contacto do encomendante ou introduza o ID de contacto
Priority	PRIORITY		string	Selecione a prioridade ou insira um ID de prioridade válido
Projeto	PRJC		string	Selecione o projeto ou insira o ID do projeto
Comments	REMARKS		string	Inserir comentários
Series	SERIES	True	string	Selecione a Série da Reunião ou insira o ID da Série
Cliente	TRDR		string	Selecione o cliente ou insira o ID do cliente
Inserir data	TRNDATE		date-time	Especifique a data em que a reunião foi criada no formato AAAA-MM-DD ou deixe-a em branco para hoje
linha n.º	LINENUM		string	Especifique a linha nº. da rubrica anexa
nome	NAME		string	Especifique o nome do arquivo do item anexado
URL	SOFNAME		string	Especifique o endereço url do item anexado
FORMULÁRIO	FORM		string	Especificar o formulário da reunião
CHAVE	KEY		string	Insira um ID de registro de reunião válido para modificá-lo

Devoluções

Body

setData200response

Inserir ou modificar tarefa

ID da Operação:

SetSOTASK

Insira ou modifique os dados de um objeto de tarefa identificado por uma CHAVE (ID da tarefa) . Se a CHAVE estiver vazia ou faltando, um registro será inserido.

Parâmetros

Name	Chave	Necessário	Tipo	Description
Operator	ACTOR		string	Selecione o operador ou insira o ID do operador
Contacto do operador	ACTPRSN		string	Selecione o contacto do operador ou introduza o ID de contacto
Situação	ACTSTATUS		string	Selecione o status (0 para 'Indiferente', 1 para 'A ser ativado', 2 para 'Em andamento', 3 para 'Concluído', 4 para 'Cancelado', 5 para 'Aguardando', 6 para 'Adiado')
Assunto	COMMENTS		string	Especificar o assunto da tarefa
Data de vencimento	FINALDATE		date-time	Especifique a data de conclusão da tarefa no formato AAAA-MM-DD ou deixe-a em branco para hoje
Data de início	FROMDATE		date-time	Especifique a data em que a tarefa foi criada no formato AAAA-MM-DD ou deixe-a em branco para hoje
Encomendado por	ORDEREDBY		string	Selecione o encomendante ou introduza o ID do encomendante
Encomendado por Contacto	ORDPRSN		string	Selecione o contacto do encomendante ou introduza o ID de contacto
Priority	PRIORITY		string	Selecione a prioridade ou insira um ID de prioridade válido
Projeto	PRJC		string	Selecione o projeto ou insira o ID do projeto
Comments	REMARKS		string	Inserir comentários
Series	SERIES	True	string	Selecione a Série da Tarefa ou insira o ID da Série
Cliente	TRDR		string	Selecione o cliente ou insira o ID do cliente
Inserir data	TRNDATE		date-time	Especifique a data em que a tarefa foi criada no formato AAAA-MM-DD ou deixe-a em branco para hoje
linha n.º	LINENUM		string	Especifique a linha nº. da rubrica anexa
nome	NAME		string	Especifique o nome do arquivo do item anexado
URL	SOFNAME		string	Especifique o endereço url do item anexado
FORMULÁRIO	FORM		string	Especificar o formulário da tarefa
CHAVE	KEY		string	Insira um ID de registro de tarefa válido para modificá-lo

Devoluções

Body

setData200response

Microsserviço

ID da Operação:

Microservice

Faz uma chamada para um microsserviço Soft1. Insira o corpo da solicitação e o ponto de extremidade do serviço Web.

Parâmetros

Name	Chave	Necessário	Tipo	Description
Body	body	True	string	Inserir corpo do pedido
Ponto final	endpoint	True	string	Especificar o ponto de extremidade url do serviço Web

Obter cheque

ID da Operação:

GetCheque

Devolve todos os dados (ou os dados selecionados de LOCATEINFO) de um registo de um objeto de cheque

Parâmetros

Name	Chave	Necessário	Tipo	Description
FORMULÁRIO	FORM		string	Especificar o formulário do cheque
CHAVE	KEY	True	string	Inserir um ID de registo de cheque válido
LOCALIZARINFO	LOCATEINFO	True	string	Especificar os campos desejados do cheque

Devoluções

Name	Caminho	Tipo	Description
Legenda	caption	string	Legenda descritiva do registo do cheque
Chave remota	remoteKey	string	ID do aplicativo de terceiros
banco	data.CHEQUE.BANK	string	O banco do cheque
código bancário	data.CHEQUE.BANK_BANK_CODE	string	Código bancário do cheque
Nome do banco	data.CHEQUE.BANK_BANK_NAME	string	Nome do banco do cheque
saldo	data.CHEQUE.CHEQUEBAL	string	Saldo do cheque
número	data.CHEQUE.CHEQUENUMBER	string	Número do cheque
state	data.CHEQUE.CHEQUESTATES	string	Estado do cheque
valor	data.CHEQUE.CHEQUEVAL	string	Valor do cheque
Companhia	data.CHEQUE.COMPANY	string	A empresa do cheque
Endereço do emissor	data.CHEQUE.CREATORADDR	string	Endereço do emissor do cheque
Nome do emissor	data.CHEQUE.CREATORNAME	string	Nome do emissor do cheque
telefone emissor	data.CHEQUE.CREATORPHONE	string	Telefone emissor do cheque
data de receção	data.CHEQUE.CRTDATE	string	Data de receção do cheque
data de emissão	data.CHEQUE.DATEOFS	string	Data de emissão do cheque
data de vencimento	data.CHEQUE.FINALDATE	date-time	Data de vencimento do cheque
Endereço do titular	data.CHEQUE.HOLDERADDR	string	Endereço do titular do cheque
Nome do titular	data.CHEQUE.HOLDERNAME	string	Nome do titular do cheque
emitente T.R.No	data.CHEQUE.PUBLISHERAFM	string	Número de Identificação Fiscal do emissor do cheque
comments	data.CHEQUE.REMARKS	string	Comentários do cheque
série	data.CHEQUE.SERIES	string	A série do cheque
moeda	data.CHEQUE.SOCURRENCY	string	A moeda do cheque
código do titular	data.CHEQUE.TRDRPOSSESSOR_TRDR_CODE	string	Código do titular do cheque
código do emissor	data.CHEQUE.TRDRPUBLISHER_TRDR_CODE	string	Código do emissor do cheque
Erro	error	string	Mensagem de erro se a ação não for bem-sucedida
Código de erro	errorcode	integer	Código de erro se a ação não for bem-sucedida
Sucesso	success	boolean	A ação é bem-sucedida?

Obter Cliente

ID da Operação:

GetCustomer

Retorna todos os dados (ou os selecionados de LOCATEINFO) de um registro de um objeto do cliente.

Parâmetros

Name	Chave	Necessário	Tipo	Description
FORMULÁRIO	FORM		string	Especificar formulário do cliente
CHAVE	KEY	True	string	Inserir um ID de registo de cliente válido
LOCALIZARINFO	LOCATEINFO	True	string	Especificar os campos de dados desejados pelo cliente

Devoluções

Name	Caminho	Tipo	Description
Legenda	caption	string	Uma legenda descritiva do registo.
Chave remota	remoteKey	string	ID do aplicativo de terceiros
Endereço principal	data.CUSTOMER.ADDRESS	string	O endereço principal do cliente
T.R.No	data.CUSTOMER.AFM	string	Número de identificação fiscal do cliente
área geográfica	data.CUSTOMER.AREAS	string	A área geográfica do cliente
city	data.CUSTOMER.CITY	string	A cidade do cliente
Código	data.CUSTOMER.CODE	string	Código do cliente
desconto (%)	data.CUSTOMER.DISCOUNT	string	Percentagem (%) de desconto do cliente
área de localização	data.CUSTOMER.DISTRICT	string	A área de localização do cliente
correio electrónico	data.CUSTOMER.EMAIL	string	O endereço de e-mail do cliente
Fax	data.CUSTOMER.FAX	string	O número de FAX do cliente
Repartição de Finanças	data.CUSTOMER.IRSDATA	string	A repartição fiscal do cliente
Active	data.CUSTOMER.ISACTIVE	string	O cliente é ativo?
profissão	data.CUSTOMER.JOBTYPETRD	string	A profissão do cliente
nome	data.CUSTOMER.NAME	string	O nome do cliente
Telefone principal	data.CUSTOMER.PHONE01	string	O número de telefone principal do cliente
comments	data.CUSTOMER.REMARKS	string	Comentários sobre o registo de clientes
Categoria fiscal	data.CUSTOMER.VATSTS	string	A categoria fiscal do cliente
ZIP	data.CUSTOMER.ZIP	string	O código postal do cliente
Erro	error	string	Mensagem de erro se a ação não for bem-sucedida
Código de erro	errorcode	integer	Código de erro se a ação não for bem-sucedida
Sucesso	success	boolean	A ação é bem-sucedida?

Obter contato

ID da Operação:

GetContact

Retorna todos os dados (ou os selecionados de LOCATEINFO) de um registro de um objeto de contato

Parâmetros

Name	Chave	Necessário	Tipo	Description
FORMULÁRIO	FORM		string	Especificar formulário de contacto
CHAVE	KEY	True	string	Inserir um ID de registo de contacto válido
LOCALIZARINFO	LOCATEINFO	True	string	Especificar os campos de dados desejados do documento

Devoluções

Name	Caminho	Tipo	Description
Legenda	caption	string	Breve legenda do registo de contacto
Chave remota	remoteKey	string	ID do aplicativo de terceiros
address	data.PRSNOUT.ADDRESS	string	O endereço do contacto
T.R.No	data.PRSNOUT.AFM	string	Número de Identificação Fiscal do contacto
área geográfica	data.PRSNOUT.AREAS	string	ID e nome da área geográfica do contacto
Data de nascimento	data.PRSNOUT.BIRTHDATE	string	A data de nascimento do contacto
ramificar	data.PRSNOUT.BRANCH	string	Nome e ID da filial do contato
city	data.PRSNOUT.CITY	string	A cidade do contacto
código	data.PRSNOUT.CODE	string	O código do contacto
country	data.PRSNOUT.COUNTRY	string	ID do país e nome do contacto
Distrito	data.PRSNOUT.DISTRICT	string	A área de localização do contacto
primeiro e-mail	data.PRSNOUT.EMAIL	string	O primeiro endereço de e-mail do contato
segundo e-mail	data.PRSNOUT.EMAIL1	string	O segundo endereço de e-mail do contato
Fax	data.PRSNOUT.FAX	string	O número de fax do contacto
N.º do Bilhete de Identidade	data.PRSNOUT.IDENTITYNUM	string	O número do cartão de identificação do contacto
repartição de finanças	data.PRSNOUT.IRSDATA	string	A repartição fiscal do contacto
Active	data.PRSNOUT.ISACTIVE	string	O contato é ativo?
telemóvel	data.PRSNOUT.MOBILEPHONE	string	O telemóvel do contacto
nome	data.PRSNOUT.NAME	string	O nome do contacto
Apelido	data.PRSNOUT.NAME2	string	Apelido do contacto
nacionalidade	data.PRSNOUT.NATIONALITY	string	Nacionalidade, ID e nome do contacto
Telefone. 1	data.PRSNOUT.PHONE1	string	O primeiro número de telefone do contacto
Telefone. 2	data.PRSNOUT.PHONE2	string	O segundo número de telefone do contacto
telefone interno	data.PRSNOUT.PHONEEXT	string	Telefone interno do contacto
telefone pessoal	data.PRSNOUT.PHONELOCAL	string	Telefone residencial do contato
comments	data.PRSNOUT.REMARKS	string	Comentários do contacto
Género	data.PRSNOUT.SOSEX	string	O sexo do contacto
página web	data.PRSNOUT.WEBPAGE	string	Página Web do contacto
ZIP	data.PRSNOUT.ZIP	string	Código postal do contacto
Item em anexo	data.XTRDOCDATA	array of object	Matriz de dados de itens anexados
n.º da linha	data.XTRDOCDATA.LINENUM	string	Número da linha do item anexado
nome	data.XTRDOCDATA.NAME	string	Nome do arquivo do item anexado
URL	data.XTRDOCDATA.SOFNAME	string	Endereço url do item anexado
Erro	error	string	Mensagem de erro se a ação não for bem-sucedida
Código de erro	errorcode	integer	Código de erro se a ação não for bem-sucedida
Sucesso	success	boolean	A ação é bem-sucedida?

Obter Despesas

ID da Operação:

GetExpense

Retorna todos os dados (ou os selecionados de LOCATEINFO) de um registro de um objeto Expense.

Parâmetros

Name	Chave	Necessário	Tipo	Description
FORMULÁRIO	FORM		string	Especificar formulário de despesa
CHAVE	KEY	True	string	Inserir um ID de registo de despesas válido
LOCALIZARINFO	LOCATEINFO	True	string	Especificar os campos desejados do serviço

Devoluções

Name	Caminho	Tipo	Description
Legenda	caption	string	Legenda descritiva do registo da despesa
Chave remota	remoteKey	string	ID do aplicativo de terceiros
código	data.LINEITEM.CODE	string	Código da despesa
Active	data.LINEITEM.ISACTIVE	string	A despesa é ativa?
categoria de faturação	data.LINEITEM.LISOURCETYPE	string	A categoria de faturamento da despesa
categoria comercial	data.LINEITEM.MTRCATEGORY	string	A categoria comercial da despesa
tipo	data.LINEITEM.MTRTYPE	string	O tipo de despesa
descrição	data.LINEITEM.NAME	string	O nome da despesa
comments	data.LINEITEM.REMARKS	string	Comentários da despesa
Valor da taxa	data.LINEITEM.SOPAYVALUE	string	Valor da taxa da despesa
Grupo IVA	data.LINEITEM.VAT	string	Imposto sobre o Valor Acrescentado da despesa
Erro	error	string	Mensagem de erro se a ação não for bem-sucedida
Código de erro	errorcode	integer	Código de erro se a ação não for bem-sucedida
Sucesso	success	boolean	A ação é bem-sucedida?

Obter documento de coleções

ID da Operação:

GetCFNCUSDOC

Retorna todos os dados (ou os selecionados de LOCATEINFO) de um registro de um objeto Collections.

Parâmetros

Name	Chave	Necessário	Tipo	Description
FORMULÁRIO	FORM		string	Especificar formulário do documento
CHAVE	KEY	True	string	Inserir um ID de registo de documento válido
LOCALIZARINFO	LOCATEINFO	True	string	Especificar os campos de dados desejados do documento

Devoluções

Name	Caminho	Tipo	Description
Legenda	caption	string	Legenda descritiva do registo do documento
Chave remota	remoteKey	string	ID do aplicativo de terceiros
Cartões de crédito	data.CARDLINES	array of object	Matriz de dados de cartões de crédito
Não.	data.CARDLINES.CRDCARDNUM	string	O número do cartão de crédito
ID	data.CARDLINES.CREDITCARDS	string	Nome e ID do cartão de crédito
número da linha	data.CARDLINES.LINENUM	string	O número da linha do cartão de crédito
valor da linha	data.CARDLINES.LINEVAL	string	O valor da linha de crédito do cartão de crédito
Dinheiro	data.CASHLINES	array of object	Matriz de dados de dinheiro
n.º da linha	data.CASHLINES.LINENUM	string	O número da linha do dinheiro
valor da linha	data.CASHLINES.LINEVAL	string	O valor da linha de caixa
moeda	data.CASHLINES.SOCURRENCY	string	A moeda do dinheiro
recoletor	data.CFNCUSDOC.COLLECTOR	string	ID do coletor do documento
Sobrenome do colecionador	data.CFNCUSDOC.COLLECTOR_PRSNIN_NAME2	string	Apelido do colecionador do documento
Companhia	data.CFNCUSDOC.COMPANY	string	Nome e ID da empresa do documento
código	data.CFNCUSDOC.FINCODE	string	Código do documento
projecto	data.CFNCUSDOC.PRJC	string	ID do projeto do documento
nome do projeto	data.CFNCUSDOC.PRJC_PRJC_NAME	date-time	O nome do projeto do documento
comments	data.CFNCUSDOC.REMARKS	string	Comentários sobre o documento
vendedor	data.CFNCUSDOC.SALESMAN	string	ID do vendedor do documento
Sobrenome do vendedor	data.CFNCUSDOC.SALESMAN_PRSNIN_NAME2	string	Apelido do vendedor do documento
série	data.CFNCUSDOC.SERIES	string	Série de documentos
total	data.CFNCUSDOC.SUMAMNT	string	Valor total do documento
cliente	data.CFNCUSDOC.TRDR	string	ID do cliente do documento
Código do Cliente	data.CFNCUSDOC.TRDR_TRDR_CODE	string	Código do cliente do documento
nome do cliente	data.CFNCUSDOC.TRDR_TRDR_NAME	string	Nome do cliente do documento
data da transação	data.CFNCUSDOC.TRNDATE	date-time	Data da transação do documento
Cheque	data.CHEQUELINES	array of object	Matriz de dados de cheques
data de vencimento	data.CHEQUELINES.CFINALDATE	date-time	DATA FINAL
código	data.CHEQUELINES.CODE	string	CÓDIGO
série	data.CHEQUELINES.CSERIES	string	SÉRIE
número da linha	data.CHEQUELINES.LINENUM	string	LINENUM
valor da linha	data.CHEQUELINES.LINEVAL	string	LINEVAL
tipo de transação	data.CHEQUELINES.TPRMS	string	TPRMS
Erro	error	string	Mensagem de erro se a ação não for bem-sucedida
Código de erro	errorcode	integer	Código de erro se a ação não for bem-sucedida
Sucesso	success	boolean	A ação é bem-sucedida?

Obter documento de compras

ID da Operação:

GetPurdoc

Retorna todos os dados (ou os selecionados de LOCATEINFO) de um registro de um objeto de compra.

Parâmetros

Name	Chave	Necessário	Tipo	Description
FORMULÁRIO	FORM		string	Especificar formulário do documento
CHAVE	KEY	True	string	Inserir um ID de registo de documento válido
LOCALIZARINFO	LOCATEINFO	True	string	Especificar os campos de dados desejados do documento

Devoluções

Name	Caminho	Tipo	Description
Legenda	caption	string	Breve legenda do registo do documento
Chave remota	remoteKey	string	ID do aplicativo de terceiros
Itens	data.ITELINES	array of object	Matriz de dados de itens
desconto	data.ITELINES.DISC1PRC	string	Desconto do item do documento
número da linha	data.ITELINES.LINENUM	string	Número da linha de item do documento
valor	data.ITELINES.LINEVAL	string	O valor da linha de item do documento
ID	data.ITELINES.MTRL	string	ID do item do documento
código	data.ITELINES.MTRL_ITEM_CODE	string	Código do item do documento
nome	data.ITELINES.MTRL_ITEM_NAME	string	O nome do item do documento
Preço	data.ITELINES.PRICE	string	O preço do item do documento
quantidade	data.ITELINES.QTY	string	Quantidade do item do documento
Empresa	data.MTRDOC.COMPANY	string	ID da empresa do documento
Data de entrega	data.MTRDOC.DELIVDATE	date-time	Data de entrega do documento
Endereço de envio	data.MTRDOC.SHIPPINGADDR	string	Endereço de entrega do documento
Armazém	data.MTRDOC.WHOUSE	string	Nome e ID do armazém do documento
Companhia	data.PURDOC.COMPANY	string	Nome e ID da empresa do documento
desconto (%)	data.PURDOC.DISC1PRC	string	Percentagem(%) de desconto do documento
valor de desconto	data.PURDOC.DISC1VAL	string	Valor de desconto do documento
despesas	data.PURDOC.EXPN	string	Despesas do documento
código	data.PURDOC.FINCODE	string	Código do documento
tipo	data.PURDOC.FPRMS	string	O tipo de documento
montante líquido	data.PURDOC.NETAMNT	string	Valor líquido do documento
pagamento	data.PURDOC.PAYMENT	string	O método de pagamento do documento
projecto	data.PURDOC.PRJC	string	ID do projeto do documento
código do projeto	data.PURDOC.PRJC_PRJC_CODE	string	Código do projeto do documento
nome do projeto	data.PURDOC.PRJC_PRJC_NAME	string	O nome do projeto do documento
comments	data.PURDOC.REMARKS	string	Comentários do documento
série	data.PURDOC.SERIES	string	A série do documento
Finalidade da entrega	data.PURDOC.SHIPKIND	string	A finalidade da entrega do documento
moeda	data.PURDOC.SOCURRENCY	string	A moeda de pagamento do documento
total	data.PURDOC.SUMAMNT	string	Valor total do documento
ID do fornecedor	data.PURDOC.TRDR	string	ID do fornecedor do documento
Endereço do fornecedor	data.PURDOC.TRDR_SUPPLIER_ADDRESS	string	Endereço do fornecedor do documento
T.R.No de fornecedores	data.PURDOC.TRDR_SUPPLIER_AFM	string	N.º de Registo Fiscal do fornecedor do documento.
Código do fornecedor	data.PURDOC.TRDR_SUPPLIER_CODE	string	Código do fornecedor do documento
fornecedor Repartição de Finanças	data.PURDOC.TRDR_SUPPLIER_IRSDATA	string	A repartição fiscal do fornecedor do documento
profissão de fornecedor	data.PURDOC.TRDR_SUPPLIER_JOBTYPETRD	string	A profissão de fornecedor do documento
Nome do fornecedor	data.PURDOC.TRDR_SUPPLIER_NAME	string	Nome do fornecedor do documento
telefone do fornecedor	data.PURDOC.TRDR_SUPPLIER_PHONE01	string	Número de telefone do fornecedor do documento
data da transação	data.PURDOC.TRNDATE	date-time	A data da transação do documento
Montante do IVA	data.PURDOC.VATAMNT	string	Valor do Imposto sobre Valor Agregado do documento
Services	data.SRVLINES	array of object	Matriz de dados de serviços
desconto	data.SRVLINES.DISC1PRC	string	O desconto de serviço do documento
número da linha	data.SRVLINES.LINENUM	string	Número da linha de serviço do documento
valor	data.SRVLINES.LINEVAL	string	Valor da linha de serviço do documento
ID	data.SRVLINES.MTRL	string	ID de serviço do documento
código	data.SRVLINES.MTRL_SERVICE_CODE	date-time	Código do serviço do ato
nome	data.SRVLINES.MTRL_SERVICE_NAME	string	O nome do serviço do documento
Preço	data.SRVLINES.PRICE	string	Preço do serviço do documento
quantidade	data.SRVLINES.QTY	string	Quantidade de serviço do documento
Análise do IVA	data.VATANAL	array of object	Matriz de análise de IVA
valor sujeito a IVA	data.VATANAL.SUBVAL	string	Valor total do documento sujeito à categoria de IVA
ID e categoria	data.VATANAL.VAT	string	ID da categoria IVA
valor	data.VATANAL.VATVAL	string	Valor total da categoria IVA
percentual(%)	data.VATANAL.VAT_VAT_PERCNT	string	Percentagem da categoria de IVA (%)
Erro	error	string	Mensagem de erro se a ação não for bem-sucedida
Código de erro	errorcode	integer	Código de erro se a ação não for bem-sucedida
Sucesso	success	boolean	A ação é bem-sucedida?

Obter Documento de Despesas

ID da Operação:

GetExpensesDoc

Retorna todos os dados (ou os selecionados de LOCATEINFO) de um registro de um objeto de despesas.

Parâmetros

Name	Chave	Necessário	Tipo	Description
FORMULÁRIO	FORM		string	Especificar formulário do documento
CHAVE	KEY	True	string	Inserir um ID de registo de documento válido
LOCALIZARINFO	LOCATEINFO		string	Especificar os campos de dados desejados do documento

Devoluções

Name	Caminho	Tipo	Description
Legenda	caption	string	Legenda descritiva do registo do documento
Chave remota	remoteKey	string	ID do aplicativo de terceiros
Despesas	data.LINLINES	array of object	Matriz de dados de despesas
número da linha	data.LINLINES.LINENUM	string	A linha de despesas do documento nº.
valor da linha	data.LINLINES.LINEVAL	string	O valor da linha de despesas do documento
ID	data.LINLINES.MTRL	string	ID da despesa do documento
código	data.LINLINES.MTRL_ITEM_CODE	string	Código de despesa do documento
nome	data.LINLINES.MTRL_ITEM_NAME	string	Nome da despesa do documento
NIF	data.LINLINES.VAT	string	A despesa do documento ID de Imposto sobre Valor Agregado
Montante do IVA	data.LINLINES.VATAMNT	string	A despesa do documento Valor Acrescentado Valor Acrescentado
Companhia	data.LINSUPDOC.COMPANY	string	ID e nome da empresa do documento
código	data.LINSUPDOC.FINCODE	string	Código do documento
pagamento	data.LINSUPDOC.PAYMENT	string	O método de pagamento do documento
série	data.LINSUPDOC.SERIES	string	Série de documentos
moeda	data.LINSUPDOC.SOCURRENCY	string	A moeda de pagamento do documento
total	data.LINSUPDOC.SUMAMNT	string	Valor total do documento
ID do fornecedor	data.LINSUPDOC.TRDR	string	ID do fornecedor do documento
T.R.No de fornecedores	data.LINSUPDOC.TRDR_SUPPLIER_AFM	string	Número de Identificação Fiscal do fornecedor do documento
Nome do fornecedor	data.LINSUPDOC.TRDR_SUPPLIER_NAME	string	Nome do fornecedor do documento
data da transação	data.LINSUPDOC.TRNDATE	date-time	Data da transação do documento
Montante do IVA	data.LINSUPDOC.VATAMNT	string	Valor do Imposto sobre Valor Agregado do documento
Erro	error	string	Mensagem de erro se a ação não for bem-sucedida
Código de erro	errorcode	integer	Código de erro se a ação não for bem-sucedida
Sucesso	success	boolean	A ação é bem-sucedida?

Obter documento de estoque

ID da Operação:

GetItedoc

Retorna todos os dados (ou os selecionados de LOCATEINFO) de um registro de um objeto de documento de estoque.

Parâmetros

Name	Chave	Necessário	Tipo	Description
FORMULÁRIO	FORM		string	Especificar formulário do documento
CHAVE	KEY	True	string	Inserir um ID de registo de documento válido
LOCALIZARINFO	LOCATEINFO	True	string	Especificar os campos de dados desejados do documento

Devoluções

Name	Caminho	Tipo	Description
Legenda	caption	string	Legenda descritiva do registo do documento
Chave remota	remoteKey	string	ID do aplicativo de terceiros
razão	data.ITEDOC.COMMENTS	string	O motivo do documento
Companhia	data.ITEDOC.COMPANY	string	ID e nome da empresa do documento
código	data.ITEDOC.FINCODE	string	Código do documento
comments	data.ITEDOC.REMARKS	string	Comentários do documento
série	data.ITEDOC.SERIES	string	Série de documentos
data da transação	data.ITEDOC.TRNDATE	date-time	Data da transação do documento
Itens	data.ITELINES	array of object	Matriz de dados de itens
desconto	data.ITELINES.DISC1PRC	string	Desconto do item do documento
número da linha	data.ITELINES.LINENUM	string	A linha de item do documento nº.
valor da linha	data.ITELINES.LINEVAL	string	O valor da linha de item do documento
ID	data.ITELINES.MTRL	string	ID do item do documento
código	data.ITELINES.MTRL_ITEM_CODE	string	Código do item do documento
nome	data.ITELINES.MTRL_ITEM_NAME	string	O nome do item do documento
Preço	data.ITELINES.PRICE	string	O preço do item do documento
quantidade	data.ITELINES.QTY	string	Quantidade do item do documento
Empresa	data.MTRDOC.COMPANY	string	ID da empresa do documento
Data de entrega	data.MTRDOC.DELIVDATE	date-time	Data de entrega do documento
Endereço de envio	data.MTRDOC.SHIPPINGADDR	string	Endereço de entrega do documento
Armazém	data.MTRDOC.WHOUSE	string	Nome e ID do armazém do documento
Erro	error	string	Mensagem de erro se a ação não for bem-sucedida
Código de erro	errorcode	integer	Código de erro se a ação não for bem-sucedida
Sucesso	success	boolean	A ação é bem-sucedida?

Obter documento de pagamentos

ID da Operação:

GetCfnsupdoc

Retorna todos os dados (ou os selecionados de LOCATEINFO) de um registro de um Objeto de Pagamento.

Parâmetros

Name	Chave	Necessário	Tipo	Description
FORMULÁRIO	FORM		string	Especificar formulário do documento
CHAVE	KEY	True	string	Inserir um ID de registo de documento válido
LOCALIZARINFO	LOCATEINFO	True	string	Especificar os campos de dados desejados do documento

Devoluções

Name	Caminho	Tipo	Description
Legenda	caption	string	Legenda descritiva do registo do documento
Chave remota	remoteKey	string	ID do aplicativo de terceiros
Cartões de crédito	data.CARDLINES	array of object	Matriz de dados de cartões de crédito
Não.	data.CARDLINES.CRDCARDNUM	string	O número do cartão de crédito
ID	data.CARDLINES.CREDITCARDS	string	Nome e ID do cartão de crédito
número da linha	data.CARDLINES.LINENUM	string	O número da linha do cartão de crédito
valor da linha	data.CARDLINES.LINEVAL	string	O valor da linha de crédito do cartão de crédito
Dinheiro	data.CASHLINES	array of object	Matriz de dados de dinheiro
número da linha	data.CASHLINES.LINENUM	string	O número da linha do dinheiro
valor da linha	data.CASHLINES.LINEVAL	string	O valor da linha de caixa
moeda de linha	data.CASHLINES.SOCURRENCY	string	A moeda do dinheiro
razão	data.CFNSUPDOC.COMMENTS	string	O motivo do documento
Companhia	data.CFNSUPDOC.COMPANY	string	Nome e ID da empresa do documento
código	data.CFNSUPDOC.FINCODE	string	Código do documento
projecto	data.CFNSUPDOC.PRJC	string	ID do projeto do documento
nome do projeto	data.CFNSUPDOC.PRJC_PRJC_NAME	date-time	O nome do projeto do documento
série	data.CFNSUPDOC.SERIES	string	Série de documentos
total	data.CFNSUPDOC.SUMAMNT	string	Valor total do documento
fornecedor	data.CFNSUPDOC.TRDR	string	ID do fornecedor do documento
Endereço do fornecedor	data.CFNSUPDOC.TRDR_TRDR_ADDRESS	string	Endereço do fornecedor do documento
T.R.No de fornecedores	data.CFNSUPDOC.TRDR_TRDR_AFM	string	Número de Identificação Fiscal do fornecedor do documento (T.R.No)
Código do fornecedor	data.CFNSUPDOC.TRDR_TRDR_CODE	string	Código do fornecedor do documento
Repartição de Finanças de Fornecedores	data.CFNSUPDOC.TRDR_TRDR_IRSDATA	string	A repartição fiscal do fornecedor do documento
Nome do fornecedor	data.CFNSUPDOC.TRDR_TRDR_NAME	string	Nome do fornecedor do documento
data da transação	data.CFNSUPDOC.TRNDATE	date-time	Data da transação do documento
Cheque	data.CHEQUELINES	array of object	Matriz de dados de cheques
data de vencimento	data.CHEQUELINES.CFINALDATE	date-time	DATA FINAL
código	data.CHEQUELINES.CODE	string	CÓDIGO
série	data.CHEQUELINES.CSERIES	string	SÉRIE
número da linha	data.CHEQUELINES.LINENUM	string	LINENUM
valor da linha	data.CHEQUELINES.LINEVAL	string	LINEVAL
tipo de transação	data.CHEQUELINES.TPRMS	string	TPRMS
Erro	error	string	Mensagem de erro se a ação não for bem-sucedida
Código de erro	errorcode	integer	Código de erro se a ação não for bem-sucedida
Sucesso	success	boolean	A ação é bem-sucedida?

Obter documento de vendas

ID da Operação:

GetSaldoc

Retorna todos os dados (ou os selecionados de LOCATEINFO) de um registro de um objeto Sales.

Parâmetros

Name	Chave	Necessário	Tipo	Description
FORMULÁRIO	FORM		string	Especificar formulário do documento
CHAVE	KEY	True	string	Inserir um ID de registo de documento válido
LOCALIZARINFO	LOCATEINFO	True	string	Especificar os campos de dados desejados do documento

Devoluções

Name	Caminho	Tipo	Description
Legenda	caption	string	Legenda descritiva do registo do documento
Chave remota	remoteKey	string	ID do aplicativo de terceiros
Itens	data.ITELINES	array of object	Matriz de dados de itens
desconto	data.ITELINES.DISC1PRC	string	Desconto do item do documento
número da linha	data.ITELINES.LINENUM	string	A linha de item do documento nº.
valor da linha	data.ITELINES.LINEVAL	string	O valor da linha de item do documento
ID	data.ITELINES.MTRL	string	ID do item do documento
código	data.ITELINES.MTRL_ITEM_CODE	string	Código do item do documento
nome	data.ITELINES.MTRL_ITEM_NAME	string	O nome do item do documento
Preço	data.ITELINES.PRICE	string	O preço do item do documento
quantidade	data.ITELINES.QTY	string	Quantidade do item do documento
Empresa	data.MTRDOC.COMPANY	string	ID da empresa do documento
Data de entrega	data.MTRDOC.DELIVDATE	date-time	Data de entrega do documento
Endereço de envio	data.MTRDOC.SHIPPINGADDR	string	Endereço de entrega do documento
Armazém	data.MTRDOC.WHOUSE	string	Nome e ID do armazém do documento
Companhia	data.SALDOC.COMPANY	string	Nome e ID da empresa do documento
desconto (%)	data.SALDOC.DISC1PRC	string	Percentagem(%) de desconto do documento
valor de desconto	data.SALDOC.DISC1VAL	string	Valor de desconto do documento
despesas	data.SALDOC.EXPN	string	Despesas do documento
código	data.SALDOC.FINCODE	string	Código do documento
tipo	data.SALDOC.FPRMS	string	O tipo de documento
montante líquido	data.SALDOC.NETAMNT	string	Valor líquido do documento
pagamento	data.SALDOC.PAYMENT	string	O método de pagamento do documento
comments	data.SALDOC.REMARKS	string	Comentários do documento
série	data.SALDOC.SERIES	string	Série de documentos
Finalidade da entrega	data.SALDOC.SHIPKIND	string	A finalidade da entrega do documento
moeda	data.SALDOC.SOCURRENCY	string	A moeda de pagamento do documento
total	data.SALDOC.SUMAMNT	string	Valor total do documento
ID do cliente	data.SALDOC.TRDR	string	ID do cliente do documento
endereço do cliente	data.SALDOC.TRDR_CUSTOMER_ADDRESS	string	Endereço do cliente do documento
T.R.No do cliente	data.SALDOC.TRDR_CUSTOMER_AFM	string	Número de Identificação Fiscal do cliente do documento
Código do Cliente	data.SALDOC.TRDR_CUSTOMER_CODE	string	Código do cliente do documento
cliente Repartição de Finanças	data.SALDOC.TRDR_CUSTOMER_IRSDATA	string	A repartição fiscal do cliente do documento
profissão do cliente	data.SALDOC.TRDR_CUSTOMER_JOBTYPETRD	string	A profissão do cliente do documento
nome do cliente	data.SALDOC.TRDR_CUSTOMER_NAME	string	Nome do cliente do documento
telefone do cliente	data.SALDOC.TRDR_CUSTOMER_PHONE01	string	Número de telefone do cliente do documento
data da transação	data.SALDOC.TRNDATE	date-time	Data da transação do documento
Montante do IVA	data.SALDOC.VATAMNT	string	Valor do Imposto sobre Valor Agregado do documento
Services	data.SRVLINES	array of object	Matriz de dados de serviços
desconto	data.SRVLINES.DISC1PRC	string	O desconto de serviço do documento
número da linha	data.SRVLINES.LINENUM	string	Número da linha de serviço do documento
valor	data.SRVLINES.LINEVAL	string	Valor da linha de serviço do documento
ID	data.SRVLINES.MTRL	string	ID de serviço do documento
código	data.SRVLINES.MTRL_SERVICE_CODE	string	Código do serviço do ato
nome	data.SRVLINES.MTRL_SERVICE_NAME	string	O nome do serviço do documento
Preço	data.SRVLINES.PRICE	string	Preço do serviço do documento
quantidade	data.SRVLINES.QTY	string	Quantidade de serviço do documento
Análise do IVA	data.VATANAL	array of object	Matriz de análise de IVA
valor sujeito a IVA	data.VATANAL.SUBVAL	string	Valor total do documento sujeito à categoria de IVA
ID e categoria	data.VATANAL.VAT	string	ID da categoria IVA
valor	data.VATANAL.VATVAL	string	Valor total da categoria IVA
percentual(%)	data.VATANAL.VAT_VAT_PERCNT	string	Percentagem da categoria de IVA (%)
Erro	error	string	Mensagem de erro se a ação não for bem-sucedida
Código de erro	errorcode	integer	Código de erro se a ação não for bem-sucedida
Sucesso	success	boolean	A ação é bem-sucedida?

Obter entrada de rascunho

ID da Operação:

GetDraftEntry

Retorna todos os dados (ou os selecionados de LOCATEINFO) de um registro de um objeto de entrada Rascunho

Parâmetros

Name	Chave	Necessário	Tipo	Description
FORMULÁRIO	FORM		string	Especificar formulário do documento
CHAVE	KEY	True	string	Inserir um ID de registo de documento válido
LOCALIZARINFO	LOCATEINFO	True	string	Especificar os campos de dados desejados do documento

Devoluções

Name	Caminho	Tipo	Description
Legenda	caption	string	Breve legenda do registo de inscrição preliminar
Chave remota	remoteKey	string	ID do aplicativo de terceiros
address	data.SODRAFT.ADDRESS	string	Endereço do projeto de entrada
T.R.No	data.SODRAFT.AFM	string	Número de Identificação Fiscal da versão preliminar
city	data.SODRAFT.CITY	string	A cidade da entrada do projeto
código	data.SODRAFT.CODE	string	O código da entrada preliminar
country	data.SODRAFT.COUNTRY	string	País do projeto de entrada
área	data.SODRAFT.DISTRICT	string	A área de entrada do rascunho
prefeitura	data.SODRAFT.DISTRICT1	string	O projeto de entrada da prefeitura
categoria	data.SODRAFT.DRAFTTYPE	string	Categoria do projeto de entrada
E-mail da empresa	data.SODRAFT.EMAIL	string	E-mail da empresa do projeto de entrada
E-mail comercial	data.SODRAFT.EMAIL1	string	E-mail comercial da entrada de rascunho
E-mail pessoal	data.SODRAFT.EMAIL2	string	O e-mail pessoal da entrada de rascunho
N.º do Bilhete de Identidade	data.SODRAFT.IDENTITYNUM	string	Número do cartão de identificação da entrada de rascunho
actividade	data.SODRAFT.JOBTYPETRD	string	Atividade do projeto de entrada
telemóvel	data.SODRAFT.MOBILEPHONE	string	O projeto de entrada do telemóvel
nome/título	data.SODRAFT.NAMEC	string	Nome/título da entrada de rascunho
Nome próprio	data.SODRAFT.NAMEF	string	O primeiro nome da entrada de rascunho
Apelido	data.SODRAFT.NAMEL	string	O apelido da entrada de rascunho
General Com. Reg.	data.SODRAFT.NUMCG	string	O projeto de inscrição na Conservatória do Registo Comercial Geral
Telefone comercial	data.SODRAFT.PHONE1	string	O projeto de entrada do telefone comercial
telefone interno	data.SODRAFT.PHONEEXT	string	Telefone interno do projeto de entrada
telefone pessoal	data.SODRAFT.PHONELOCAL	string	O telefone pessoal do projeto de entrada
comments	data.SODRAFT.REMARKS	string	Comentários do projeto de entrada
title	data.SODRAFT.SOTITLENAME	string	Título do projeto de entrada
página web	data.SODRAFT.WEBPAGE	string	Página Web do projeto de entrada
ZIP	data.SODRAFT.ZIP	string	Código postal da entrada de rascunho
ramificar	data.SODRAFTLNK.BRANCH	string	Nome e ID da sucursal da entrada de rascunho
Unidade de Negócio	data.SODRAFTLNK.BUSUNITS	string	Nome e ID da unidade de negócios da entrada de rascunho
departamento	data.SODRAFTLNK.DEPART	string	O departamento de entrada de rascunho
projecto	data.SODRAFTLNK.PRJC	string	O projeto de entrada de rascunho
origem	data.SODRAFTLNK.PRJCLEAD	string	Nome de origem e ID da entrada de rascunho
Erro	error	string	Mensagem de erro se a ação não for bem-sucedida
Código de erro	errorcode	integer	Código de erro se a ação não for bem-sucedida
Sucesso	success	boolean	A ação é bem-sucedida?

Obter Fornecedor

ID da Operação:

GetSupplier

Retorna todos os dados (ou os selecionados de LOCATEINFO) de um registro de um objeto de fornecedor.

Parâmetros

Name	Chave	Necessário	Tipo	Description
FORMULÁRIO	FORM		string	Especificar o formulário do fornecedor
CHAVE	KEY	True	string	Inserir um ID de registo de fornecedor válido
LOCALIZARINFO	LOCATEINFO	True	string	Especificar os campos de dados desejados pelo fornecedor

Devoluções

Name	Caminho	Tipo	Description
Legenda	caption	string	Legenda descritiva do registo do fornecedor
Chave remota	remoteKey	string	ID do aplicativo de terceiros
Contas bancárias	data.SUPBANKACC	array of object	Matriz de dados de contas bancárias
Nome do banco	data.SUPBANKACC.BANK	string	Nome do banco da conta bancária
código	data.SUPBANKACC.BANK_BANK_CODE	string	Código do banco
IBAN	data.SUPBANKACC.IBAN	string	Número de conta bancária internacional
n.º da linha	data.SUPBANKACC.LINENUM	string	Número da linha da conta bancária
comments	data.SUPBANKACC.REMARKS	string	Comentários sobre a conta bancária
address	data.SUPPLIER.ADDRESS	string	O endereço principal do fornecedor
T.R.No	data.SUPPLIER.AFM	string	Número de identificação fiscal do fornecedor
city	data.SUPPLIER.CITY	string	Percentagem (%) de desconto do cliente
Código do fornecedor	data.SUPPLIER.CODE	string	Código de registo do fornecedor
área de localização	data.SUPPLIER.DISTRICT	string	A área de localização do fornecedor
correio electrónico	data.SUPPLIER.EMAIL	string	O endereço de e-mail do fornecedor
TELEFAX	data.SUPPLIER.FAX	string	O número de FAX do fornecedor
repartição de finanças	data.SUPPLIER.IRSDATA	string	A repartição fiscal do fornecedor
Active	data.SUPPLIER.ISACTIVE	string	O fornecedor está ativo?
profissão	data.SUPPLIER.JOBTYPETRD	string	A profissão do fornecedor
nome	data.SUPPLIER.NAME	string	O nome do fornecedor
Telefone principal	data.SUPPLIER.PHONE01	string	O número de telefone principal do fornecedor
comments	data.SUPPLIER.REMARKS	string	Comentários sobre o registo de fornecedores
Categoria fiscal	data.SUPPLIER.VATSTS	string	A categoria fiscal do fornecedor
CEP	data.SUPPLIER.ZIP	string	O código postal do fornecedor
Erro	error	string	Mensagem de erro se a ação não for bem-sucedida
Código de erro	errorcode	integer	Código de erro se a ação não for bem-sucedida
Sucesso	success	boolean	A ação é bem-sucedida?

Obter parâmetros do sistema

ID da Operação:

GetSystemParams

Retorna parâmetros da instalação

Devoluções

Name	Caminho	Tipo	Description
address	companyinfo.address	string	O endereço da empresa
T.R.No	companyinfo.afm	string	O Número de Identificação Fiscal da empresa
address	companyinfo.branch.address	string	O endereço da sucursal da empresa
área de localização	companyinfo.branch.district	string	A área de localização da sucursal da empresa
nome	companyinfo.branch.name	string	O nome da sucursal da empresa
ZIP	companyinfo.branch.zip	string	O código postal da sucursal da empresa
área de localização	companyinfo.district	string	A área de localização da empresa
e-mail	companyinfo.email	string	O e-mail da empresa
Logótipo	companyinfo.image	string	URL do logótipo da empresa
repartição de finanças	companyinfo.irsdata	string	A repartição fiscal da empresa
nome	companyinfo.name	string	O nome da empresa
número de telefone	companyinfo.phone	string	O número de telefone da empresa
ZIP	companyinfo.zip	string	O código postal da empresa
Erro	error	string	Mensagem de erro se a ação não for bem-sucedida
Código de erro	errorcode	integer	Código de erro se a ação não for bem-sucedida
Número de série	serialnumber	string	O número de série da instalação
Sucesso	success	boolean	A ação é bem-sucedida?

Obter projeto

ID da Operação:

GetProject

Retorna todos os dados (ou os selecionados de LOCATEINFO) de um registro de um objeto de projeto

Parâmetros

Name	Chave	Necessário	Tipo	Description
FORMULÁRIO	FORM		string	Especificar formulário do projeto
CHAVE	KEY	True	string	Inserir um ID de registro de projeto válido
LOCALIZARINFO	LOCATEINFO	True	string	Especificar os campos de dados desejados do projeto

Devoluções

Name	Caminho	Tipo	Description
Legenda	caption	string	Breve legenda do registo do projeto
estado	data.PRJC.ACTSTATUS	string	Situação do projeto
código	data.PRJC.CODE	string	O código do projeto
data de vencimento	data.PRJC.FINALDATE	date-time	Data de vencimento do projeto
data de início	data.PRJC.FROMDATE	date-time	Data de início do projeto
Active	data.PRJC.ISACTIVE	string	O projeto está ativo?
nome	data.PRJC.NAME	string	O nome do projeto
ID	data.PRJC.PRJC	string	ID do projeto
variação	data.PRJC.PRJCRM	string	A variação do projeto
comments	data.PRJC.REMARKS	string	Comentários do projeto
Item em anexo	data.XTRDOCDATA	array of object	Matriz de dados de itens anexados
n.º da linha	data.XTRDOCDATA.LINENUM	string	Número da linha do item anexado
nome	data.XTRDOCDATA.NAME	string	Nome do arquivo do item anexado
URL	data.XTRDOCDATA.SOFNAME	string	Endereço url do item anexado
Erro	error	string	Mensagem de erro se a ação não for bem-sucedida
Código de erro	errorcode	integer	Código de erro se a ação não for bem-sucedida
Sucesso	success	boolean	A ação é bem-sucedida?

Obter reunião

ID da Operação:

GetMeeting

Retorna todos os dados (ou os selecionados de LOCATEINFO) de um registro de um objeto de reunião.

Parâmetros

Name	Chave	Necessário	Tipo	Description
FORMULÁRIO	FORM		string	Especificar o formulário da reunião
CHAVE	KEY	True	string	Inserir um ID de registo de reunião válido
LOCALIZARINFO	LOCATEINFO	True	string	Especificar os campos de dados desejados da reunião

Devoluções

Name	Caminho	Tipo	Description
Legenda	caption	string	Legenda descritiva do registo da reunião
Chave remota	remoteKey	string	ID do aplicativo de terceiros
operador	data.SOACTION.ACTOR	string	Operador da reunião
contato do operador	data.SOACTION.ACTPRSN	string	Contacto do operador da reunião
estado	data.SOACTION.ACTSTATUS	string	Situação da reunião
Assunto	data.SOACTION.COMMENTS	string	O tema da reunião
data de vencimento	data.SOACTION.FINALDATE	date-time	Data de vencimento da reunião
data de início	data.SOACTION.FROMDATE	date-time	Data de início da reunião
encomendado por	data.SOACTION.ORDEREDBY	string	Ordenador da reunião
encomendado por contacto	data.SOACTION.ORDPRSN	string	Contacto do ordenador da reunião
priority	data.SOACTION.PRIORITY	string	Prioridade da reunião
projecto	data.SOACTION.PRJC	string	O projeto do encontro
comments	data.SOACTION.REMARKS	string	Comentários sobre a reunião
série	data.SOACTION.SERIES	string	Série da reunião
concluída	data.SOACTION.TASKCOMPLETE	string	A reunião está concluída?
ID do cliente	data.SOACTION.TRDR	string	ID do cliente da reunião
nome do cliente	data.SOACTION.TRDR_GENTRDR_NAME	string	Nome do cliente da reunião
inserir data	data.SOACTION.TRNDATE	date-time	A data de criação da reunião
Erro	error	string	Mensagem de erro se a ação não for bem-sucedida
Código de erro	errorcode	integer	Código de erro se a ação não for bem-sucedida
Sucesso	success	boolean	A ação é bem-sucedida?

Obter serviços

ID da Operação:

GetService

Retorna todos os dados (ou os selecionados de LOCATEINFO) de um registro de um objeto de serviço.

Parâmetros

Name	Chave	Necessário	Tipo	Description
FORMULÁRIO	FORM		string	Especificar formulário do serviço
CHAVE	KEY	True	string	Inserir um ID de registo de serviço válido
LOCALIZARINFO	LOCATEINFO	True	string	Especificar os campos desejados do serviço

Devoluções

Name	Caminho	Tipo	Description
Legenda	caption	string	Legenda descritiva do registo do serviço
Chave remota	remoteKey	string	ID do aplicativo de terceiros
código	data.SERVICE.CODE	string	O código do serviço
Active	data.SERVICE.ISACTIVE	string	O serviço está ativo?
categoria comercial	data.SERVICE.MTRCATEGORY	string	A categoria comercial do serviço
Grupo de serviços	data.SERVICE.MTRGROUP	string	O grupo do serviço
Unidade de medida base	data.SERVICE.MTRUNIT1	string	Unidade de medida base do serviço
descrição	data.SERVICE.NAME	string	O nome do serviço
Preço de Venda ao Público	data.SERVICE.PRICER	string	Preço de venda ao público do serviço
preço por grosso	data.SERVICE.PRICEW	string	Preço grossista do serviço
comments	data.SERVICE.REMARKS	string	Comentários do serviço
desconto (%)	data.SERVICE.SODISCOUNT	string	O desconto do serviço
Grupo IVA	data.SERVICE.VAT	string	Imposto sobre o Valor Acrescentado do serviço
Erro	error	string	Mensagem de erro se a ação não for bem-sucedida
Código de erro	errorcode	integer	Código de erro se a ação não for bem-sucedida
Sucesso	success	boolean	A ação é bem-sucedida?

Obter tarefa

ID da Operação:

GetSOTASK

Retorna todos os dados (ou os selecionados de LOCATEINFO) de um registro de um objeto de tarefa.

Parâmetros

Name	Chave	Necessário	Tipo	Description
FORMULÁRIO	FORM		string	Especificar formulário da tarefa
CHAVE	KEY	True	string	Inserir um ID de registo de tarefa válido
LOCALIZARINFO	LOCATEINFO	True	string	Especificar os campos de dados desejados da tarefa

Devoluções

Name	Caminho	Tipo	Description
Legenda	caption	string	Legenda descritiva do registro de tarefa
Chave remota	remoteKey	string	ID do aplicativo de terceiros
operador	data.SOACTION.ACTOR	string	Operador da tarefa
contato do operador	data.SOACTION.ACTPRSN	string	Contacto do operador da tarefa
estado	data.SOACTION.ACTSTATUS	string	O status da tarefa
Assunto	data.SOACTION.COMMENTS	string	O sujeito da tarefa
data de vencimento	data.SOACTION.FINALDATE	date-time	Data de conclusão da tarefa
data de início	data.SOACTION.FROMDATE	date-time	Data de início da tarefa
encomendado por	data.SOACTION.ORDEREDBY	string	Ordenante da tarefa
encomendado por contacto	data.SOACTION.ORDPRSN	string	Contacto do ordenante da tarefa
priority	data.SOACTION.PRIORITY	string	Prioridade da tarefa
projecto	data.SOACTION.PRJC	string	O projeto da tarefa
comments	data.SOACTION.REMARKS	string	Comentários sobre a tarefa
série	data.SOACTION.SERIES	string	A série da tarefa
concluída	data.SOACTION.TASKCOMPLETE	string	A tarefa está concluída?
ID do cliente	data.SOACTION.TRDR	string	ID do cliente da tarefa
nome do cliente	data.SOACTION.TRDR_GENTRDR_NAME	string	O nome do cliente da tarefa
inserir data	data.SOACTION.TRNDATE	date-time	A data em que a tarefa foi criada
Erro	error	string	Mensagem de erro se a ação não for bem-sucedida
Código de erro	errorcode	integer	Código de erro se a ação não for bem-sucedida
Sucesso	success	boolean	A ação é bem-sucedida?

Receber e-mail

ID da Operação:

GetSOEMAIL

Retorna todos os dados (ou os selecionados de LOCATEINFO) de um registro de um objeto de e-mail

Parâmetros

Name	Chave	Necessário	Tipo	Description
FORMULÁRIO	FORM		string	Especifique o formulário do e-mail
CHAVE	KEY	True	string	Inserir um ID de registo de e-mail válido
LOCALIZARINFO	LOCATEINFO	True	string	Especificar os campos de dados desejados do e-mail

Devoluções

Name	Caminho	Tipo	Description
Legenda	caption	string	Breve legenda do disco
Chave remota	remoteKey	string	ID do aplicativo de terceiros
operador	data.SOACTION.ACTOR	string	Operador da tarefa
contato do operador	data.SOACTION.ACTPRSN	string	Contacto do operador da tarefa
estado	data.SOACTION.ACTSTATUS	string	O status da tarefa
Assunto	data.SOACTION.COMMENTS	string	O sujeito da tarefa
data de vencimento	data.SOACTION.FINALDATE	date-time	Data de conclusão da tarefa
data de início	data.SOACTION.FROMDATE	date-time	Data de início da tarefa
encomendado por	data.SOACTION.ORDEREDBY	string	Ordenante da tarefa
encomendado por contacto	data.SOACTION.ORDPRSN	string	Contacto do ordenante da tarefa
priority	data.SOACTION.PRIORITY	string	Prioridade da tarefa
projecto	data.SOACTION.PRJC	string	O projeto da tarefa
comments	data.SOACTION.REMARKS	string	Comentários sobre a tarefa
série	data.SOACTION.SERIES	string	A série da tarefa
concluída	data.SOACTION.TASKCOMPLETE	string	A tarefa está concluída?
ID do cliente	data.SOACTION.TRDR	string	ID do cliente da tarefa
nome do cliente	data.SOACTION.TRDR_GENTRDR_NAME	string	O nome do cliente da tarefa
inserir data	data.SOACTION.TRNDATE	date-time	A data em que a tarefa foi criada
do endereço	data.SOMAIL.FROMADDRESS	string	O endereço do proprietário e do remetente da caixa de correio
remetente	data.SOMAIL.FROMNAME	string	O nome do proprietário da caixa de correio e do remetente
date	data.SOMAIL.MAILDATE	date-time	Data do e-mail
CBC	data.SOMAIL.SOBCC	string	Os destinatários Cco da mensagem
body	data.SOMAIL.SOBODY	string	O corpo da mensagem
CC	data.SOMAIL.SOCC	string	Os destinatários Cc da mensagem
Para	data.SOMAIL.SOTO	string	Os destinatários da mensagem
Item em anexo	data.XTRDOCDATA	array of object	Matriz de dados de itens anexados
n.º da linha	data.XTRDOCDATA.LINENUM	string	Número da linha do item anexado
nome	data.XTRDOCDATA.NAME	string	Nome do arquivo do item anexado
URL	data.XTRDOCDATA.SOFNAME	string	Endereço url do item anexado
Erro	error	string	Mensagem de erro se a ação não for bem-sucedida
Código de erro	errorcode	integer	Código de erro se a ação não for bem-sucedida
Sucesso	success	boolean	A ação é bem-sucedida?

Acionadores

Quando um registo é criado	Esta operação é acionada quando há registros recém-criados do objeto selecionado
Quando um registo é criado ou modificado	Esta operação é acionada quando há registros recém-criados ou modificados do objeto selecionado
Quando um registo é eliminado	Esta operação é acionada quando um registro do objeto selecionado é excluído
Quando um registo é modificado	Esta operação é acionada quando há registros modificados do objeto selecionado

Quando um registo é criado

ID da Operação:

WebhookOnInsert

Esta operação é acionada quando há registros recém-criados do objeto selecionado

Parâmetros

Name	Chave	Necessário	Tipo	Description
Condition	condition		string	Especificar uma condição
Objeto	object	True	string	Selecione um objeto que aciona esta operação

Devoluções

Name	Caminho	Tipo	Description
ID	id	string	ID do registo que foi criado. Use com a ação 'Get' correspondente para buscar o conteúdo do registro

Quando um registo é criado ou modificado

ID da Operação:

Webhook

Esta operação é acionada quando há registros recém-criados ou modificados do objeto selecionado

Parâmetros

Name	Chave	Necessário	Tipo	Description
Condition	condition		string	Especificar uma condição
Objeto	object	True	string	Selecione um objeto que aciona esta operação

Devoluções

Name	Caminho	Tipo	Description
ID	id	string	ID do registro que foi criado ou modificado. Use com a ação 'Get' correspondente para buscar o conteúdo do registro

Quando um registo é eliminado

ID da Operação:

WebhookOnDelete

Esta operação é acionada quando um registro do objeto selecionado é excluído

Parâmetros

Name	Chave	Necessário	Tipo	Description
Condition	condition		string	Especificar uma condição
Objeto	object	True	string	Selecione um objeto que aciona esta operação

Devoluções

Name	Caminho	Tipo	Description
ID	id	string	ID do registo que foi eliminado

Quando um registo é modificado

ID da Operação:

WebhookOnUpdate

Esta operação é acionada quando há registros modificados do objeto selecionado

Parâmetros

Name	Chave	Necessário	Tipo	Description
Condition	condition		string	Especificar uma condição
Objeto	object	True	string	Selecione um objeto que aciona esta operação

Devoluções

Name	Caminho	Tipo	Description
ID	id	string	ID do registo que foi modificado. Use com a ação 'Get' correspondente para buscar o conteúdo do registro

Definições

setData200response

Name	Caminho	Tipo	Description
Erro	error	string	Mensagem de erro se a ação não for bem-sucedida
Código de erro	errorcode	integer	Código de erro se a ação não for bem-sucedida
ID	id	string	ID do registo de documento que foi criado ou modificado
Sucesso	success	boolean	A ação é bem-sucedida?