Soft1
O Conector Soft1 fornece uma API para trabalhar com objetos Soft1
Esse conector está disponível nos seguintes produtos e regiões:
| Service | Class | Regions |
|---|---|---|
| Copilot Studio | Standard | 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 | Standard | 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 | Standard | 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 | Constantino Elias |
| cfe@softone.gr |
| Metadados do conector | |
|---|---|
| Publicador | SoftOne Technologies S.A |
| Site | https://www.softone.gr |
| Política de privacidade | https://www.softone.gr/privacy-policy/ |
| Categorias | Gestão de empresas; Vendas e CRM |
O Conector Soft1 fornece uma API para trabalhar com objetos Soft1 para criar fluxos de trabalho automatizados entre aplicativos Soft1 e nossos aplicativos e serviços favoritos.
Pré-requisitos
Para usar essa integração, você precisará de acesso a uma instalação do Soft1 com o módulo Soft1 do Microsoft Power Connector habilitado. Para fazer uma conexão, selecione Entrar. Você será solicitado a fornecer seu número de série soft1, nome de usuário e senha. 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 Web deve ser configurada com acesso ao módulo Soft1 do Microsoft Power Connector – essa conta (nome de usuário e senha) e o número de série de instalação serão usados para autenticação pelo conector Soft1.
Introdução ao conector
O Conector Soft1 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 desse objeto, você precisa usar a ação Get correspondente 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.
Limitações
| Nome | Chamadas | Período de renovação |
|---|---|---|
| Chamadas à API por conexão | 100 | 60 segundos |
Ações
| Inserir Chave Remota |
Inserir iD de aplicativo de terceiros em um objeto Soft1 |
| Inserir ou modificar a entrada de rascunho |
Inserir ou modificar os dados de um objeto de entrada de rascunho identificado por um KEY (ID de entrada de rascunho) . Se a CHAVE estiver vazia ou não tiver um registro for inserida. |
| Inserir ou modificar cheque |
Insira ou modifique os dados de um objeto Cheque identificado por uma CHAVE (ID do Cheque). Se a CHAVE estiver vazia ou um registro ausente for inserido.ele os dados de um registro em um Objeto Cheque identificado por uma CHAVE. Se a CHAVE estiver vazia ou não tiver um registro for inserida. |
| Inserir ou modificar contato |
Inserir ou modificar os dados de um objeto de contato identificado por um KEY (ID de contato) . Se a CHAVE estiver vazia ou não tiver um registro for inserida. |
| Inserir ou modificar despesas |
Insira ou modifique os dados de um objeto expense identificado por um KEY (ID de despesa). Se a CHAVE estiver vazia ou um registro ausente for inserido, serão inseridos dados de um registro em um objeto expense identificado por uma CHAVE. Se a CHAVE estiver vazia ou não tiver um registro for inserida. |
| Inserir ou modificar documento de coleções |
Inserir ou modificar os dados de um objeto de documento coleções identificado por uma CHAVE (ID do documento). Se a CHAVE estiver vazia ou não tiver um registro for inserida. |
| Inserir ou modificar documento de compras |
Inserir ou modificar os dados de um objeto de documento de compra identificado por um KEY (ID do documento). Se a CHAVE estiver vazia ou não tiver um registro for inserida. |
| Inserir ou modificar documento de despesas |
Inserir ou modificar os dados de um objeto de documento expenses identificado por um KEY (ID do documento). Se a CHAVE estiver vazia ou não tiver um registro for inserida. |
| Inserir ou modificar documento de estoque |
Insira ou modifique os dados de um registro do Documento de Estoque, identificado por um KEY. 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 um KEY (ID do documento). Se a CHAVE estiver vazia ou não tiver um registro for inserida. |
| Inserir ou modificar documento de vendas |
Insira ou modifique os dados de um registro do Documento de Vendas, identificado por um KEY. Se a CHAVE estiver vazia ou ausente, um novo registro será criado |
| Inserir ou modificar email |
Inserir ou modificar os dados de um objeto de email identificado por um KEY (ID de email). Se a CHAVE estiver vazia ou não tiver um registro for inserida. |
| Inserir ou modificar fornecedor |
Inserir ou modificar os dados de um objeto fornecedor identificado por um KEY (ID do fornecedor). Se a CHAVE estiver vazia ou não tiver um registro for inserida. |
| Inserir ou modificar item |
Inserir ou modificar os dados de um objeto de item identificado por um KEY (ID do item). Se a CHAVE estiver vazia ou um registro ausente for inserido.ele os dados de um registro em um Objeto de Item identificado por uma CHAVE. Se a CHAVE estiver vazia ou não tiver um registro for inserida. |
| Inserir ou modificar o cliente |
Inserir ou modificar os dados de um objeto de cliente identificado por um KEY (ID do cliente). Se a CHAVE estiver vazia ou não tiver um registro for inserida. |
| Inserir ou modificar projeto |
Inserir ou modificar os dados de um Objeto de Projeto identificado por um KEY (ID do projeto). Se a CHAVE estiver vazia ou não tiver um registro for inserida. |
| Inserir ou modificar reunião |
Inserir ou modificar os dados de um objeto de reunião identificado por um KEY (ID da reunião). Se a CHAVE estiver vazia ou não tiver um registro for inserida. |
| Inserir ou modificar serviço |
Inserir ou modificar os dados de um objeto de serviço identificado por uma CHAVE (ID do Serviço). Se a CHAVE estiver vazia ou não tiver um registro for inserida. |
| Inserir ou modificar tarefa |
Inserir ou modificar os dados de um objeto de tarefa identificado por um KEY (ID da tarefa). Se a CHAVE estiver vazia ou não tiver um registro for inserida. |
| 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 |
Retorna todos os dados (ou os selecionados de LOCATEINFO) de um registro de um objeto 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 Expenses. |
| 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 de Vendas. |
| Obter email |
Retorna todos os dados (ou os selecionados de LOCATEINFO) de um registro de um objeto de email |
| Obter entrada de rascunho |
Retorna todos os dados (ou os selecionados de LOCATEINFO) de um registro de um objeto de entrada draft |
| Obter Fornecedor |
Retorna todos os dados (ou os selecionados de LOCATEINFO) de um registro de um objeto fornecedor. |
| Obter Item |
Retorna todos os dados (ou os selecionados de LOCATEINFO) de um registro de um objeto item. |
| 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. |
Inserir Chave Remota
Inserir iD de aplicativo de terceiros em um objeto Soft1
Parâmetros
| Nome | Chave | Obrigatório | Tipo | Description |
|---|---|---|---|---|
|
CHAVE
|
KEY | True | string |
Inserir uma ID de objeto Soft1 válida |
|
Chave Remota
|
REFID | True | string |
Inserir uma ID de aplicativo de terceiros válida |
|
Objeto Soft1
|
SOSOURCE | True | string |
Selecionar objeto Soft1 |
Retornos
- Corpo
- setData200response
Inserir ou modificar a entrada de rascunho
Inserir ou modificar os dados de um objeto de entrada de rascunho identificado por um KEY (ID de entrada de rascunho) . Se a CHAVE estiver vazia ou não tiver um registro for inserida.
Parâmetros
| Nome | Chave | Obrigatório | Tipo | Description |
|---|---|---|---|---|
|
FORMA
|
FORM | string |
Especificar o formulário da entrada de rascunho |
|
|
CHAVE
|
KEY | string |
Insira uma ID de entrada de rascunho válida para modificá-la |
|
|
Endereço
|
ADDRESS | string |
Especificar o endereço da entrada de rascunho |
|
|
T.R.No
|
AFM | string |
Especificar o número de registro de imposto da entrada de rascunho |
|
|
City
|
CITY | string |
Especificar a cidade da entrada de rascunho |
|
|
Code
|
CODE | True | string |
Inserir um código de entrada de rascunho |
|
País
|
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 |
|
|
Email da empresa
|
string |
Especificar o email da empresa da entrada de rascunho |
||
|
Email comercial
|
EMAIL1 | string |
Especificar o email comercial da entrada de rascunho |
|
|
Email pessoal
|
EMAIL2 | string |
Especificar o email pessoal da entrada de rascunho |
|
|
Cartão de ID Não
|
IDENTITYNUM | string |
Especificar o número do cartão de ID da entrada de rascunho |
|
|
Activity
|
JOBTYPETRD | string |
Especificar a atividade da entrada de rascunho |
|
|
Telemóvel
|
MOBILEPHONE | string |
Especificar o número de telefone celular da entrada de rascunho |
|
|
Nome/Título
|
NAMEC | string |
Especificar o nome/título da entrada de rascunho |
|
|
Nome
|
NAMEF | string |
Especificar o nome da entrada de rascunho |
|
|
Surname
|
NAMEL | string |
Especificar o sobrenome da entrada de rascunho |
|
|
General Com. Reg.
|
NUMCG | string |
Especificar o registro comercial geral da entrada de rascunho |
|
|
Telefone comercial
|
PHONE1 | string |
Especificar 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 |
Especificar 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 da Web
|
WEBPAGE | string |
Especificar a página da Web da entrada de rascunho |
|
|
Zip
|
ZIP | string |
Especificar o cep da entrada de rascunho |
|
|
Ramo
|
BRANCH | string |
Selecione o branch ou insira a ID do branch |
|
|
Unidade de negócios
|
BUSUNITS | string |
Selecione a unidade de negócios ou insira a ID da unidade de negócios |
|
|
Departamento
|
DEPART | string |
Selecione o departamento ou insira a ID do departamento |
|
|
Projeto
|
PRJC | string |
Selecione o projeto ou insira a ID do projeto |
|
|
Source
|
PRJCLEAD | string |
Selecione a origem ou insira a ID de origem |
Retornos
- Corpo
- setData200response
Inserir ou modificar cheque
Insira ou modifique os dados de um objeto Cheque identificado por uma CHAVE (ID do Cheque). Se a CHAVE estiver vazia ou um registro ausente for inserido.ele os dados de um registro em um Objeto Cheque identificado por uma CHAVE. Se a CHAVE estiver vazia ou não tiver um registro for inserida.
Parâmetros
| Nome | Chave | Obrigatório | Tipo | Description |
|---|---|---|---|---|
|
FORMA
|
FORM | string |
Especificar o formulário do cheque |
|
|
CHAVE
|
KEY | string |
Insira uma ID de registro de cheque válida para modificá-la |
|
|
Banco
|
BANK | string |
Selecione banco ou insira a ID do banco |
|
|
Saldo
|
CHEQUEBAL | True | string |
Especificar o saldo do cheque |
|
Número do Cheque
|
CHEQUENUMBER | True | string |
Inserir o número do cheque |
|
Situação
|
CHEQUESTATES | True | string |
Selecione o status do cheque ou insira a ID de status |
|
Value
|
CHEQUEVAL | True | string |
Especificar o valor do cheque |
|
Endereço do emissor
|
CREATORADDR | string |
Especificar o endereço do emissor |
|
|
Nome do emissor
|
CREATORNAME | string |
Especificar o nome do emissor |
|
|
Telefone emissor
|
CREATORPHONE | string |
Especificar o telefone do emissor |
|
|
Data de recebimento
|
CRTDATE | string |
Especifique a data de recebimento do cheque no formato YYYY-MM-DD ou deixe-a em branco por hoje |
|
|
Data do problema
|
DATEOFS | True | string |
Especifique a data de emissão do cheque no formato YYYY-MM-DD ou deixe-a em branco por hoje |
|
Data de conclusão
|
FINALDATE | True | date-time |
Especifique a data de conclusão do cheque no formato YYYY-MM-DD ou deixe-a em branco por hoje |
|
Endereço do titular
|
HOLDERADDR | string |
Especificar o endereço do titular do cheque |
|
|
Nome do titular
|
HOLDERNAME | string |
Especificar o nome do titular do cheque |
|
|
T.R.No do emissor
|
PUBLISHERAFM | string |
Especificar o número de registro de imposto do emissor |
|
|
Comments
|
REMARKS | string |
Inserir comentários |
|
|
Série
|
SERIES | True | string |
Inserir um código de cheque |
Retornos
- Corpo
- setData200response
Inserir ou modificar contato
Inserir ou modificar os dados de um objeto de contato identificado por um KEY (ID de contato) . Se a CHAVE estiver vazia ou não tiver um registro for inserida.
Parâmetros
| Nome | Chave | Obrigatório | Tipo | Description |
|---|---|---|---|---|
|
FORMA
|
FORM | string |
Especificar o formulário do contato |
|
|
CHAVE
|
KEY | string |
Insira uma ID de contato válida para modificá-la |
|
|
Endereço
|
ADDRESS | string |
Especificar o endereço do contato |
|
|
T.R.No
|
AFM | string |
Especificar o número de registro de imposto do contato |
|
|
Áreas Geográficas
|
AREAS | string |
Selecione a área geográfica |
|
|
Data de nascimento
|
BIRTHDATE | date-time |
Especifique a data de nascimento do contato no formato YYYY-MM-DD ou deixe-a em branco por hoje |
|
|
City
|
CITY | string |
Especificar a cidade do contato |
|
|
Code
|
CODE | True | string |
Inserir um código de contato |
|
País
|
COUNTRY | string |
Selecione o país ou insira a ID do país |
|
|
Area
|
DISTRICT | string |
Especificar a área do contato |
|
|
Prefeitura
|
DISTRICT1 | string |
Especificar a prefeitura do contato |
|
|
Nível de educação
|
EDUCAT | string |
Selecione o nível de educação do contato |
|
|
Email
|
string |
Especificar o email do contato |
||
|
Email 2
|
EMAIL1 | string |
Especificar o segundo email do contato |
|
|
Fac-símile
|
FAX | string |
Especificar o número de fax do contato |
|
|
Cartão de ID Não
|
IDENTITYNUM | string |
Especificar o número do cartão de ID do contato |
|
|
Escritório de Impostos
|
IRSDATA | string |
Selecione o escritório fiscal do contato |
|
|
Telemóvel
|
MOBILEPHONE | string |
Especificar o número de telefone celular do contato |
|
|
Nome
|
NAME | True | string |
Especificar o nome do contato |
|
Surname
|
NAME2 | string |
Especificar o sobrenome do contato |
|
|
Nome do pai
|
NAME3 | string |
Especificar o nome do pai do contato |
|
|
Nome da mãe
|
NAME4 | string |
Especificar o nome da mãe do contato |
|
|
Nome do cônjuge
|
NAME5 | string |
Especificar o nome do cônjuge do contato |
|
|
Nationality
|
NATIONALITY | string |
Selecione a nacionalidade ou insira a ID de nacionalidade |
|
|
Tel. 1
|
PHONE1 | string |
Especificar o primeiro número de telefone do contato |
|
|
Tel. 2
|
PHONE2 | string |
Especificar o segundo número de telefone do contato |
|
|
Telefone interno
|
PHONEEXT | string |
Especificar o número de telefone interno do contato |
|
|
Telefone pessoal
|
PHONELOCAL | string |
Especificar o número de telefone pessoal do contato |
|
|
Comments
|
REMARKS | string |
Inserir comentários |
|
|
Gênero
|
SOSEX | string |
Selecione o gênero do contato. '1' para Masculino e '2' para Feminino |
|
|
página da Web
|
WEBPAGE | string |
Especificar a página da Web do contato |
|
|
Zip
|
ZIP | string |
Especificar o cep do contato |
|
|
linha Não
|
LINENUM | string |
Especifique a linha Nº. do item anexado |
|
|
nome
|
NAME | string |
Especificar o nome do arquivo do item anexado |
|
|
url
|
SOFNAME | string |
Especificar o endereço de URL do item anexado |
Retornos
- Corpo
- setData200response
Inserir ou modificar despesas
Insira ou modifique os dados de um objeto expense identificado por um KEY (ID de despesa). Se a CHAVE estiver vazia ou um registro ausente for inserido, serão inseridos dados de um registro em um objeto expense identificado por uma CHAVE. Se a CHAVE estiver vazia ou não tiver um registro for inserida.
Parâmetros
| Nome | Chave | Obrigatório | Tipo | Description |
|---|---|---|---|---|
|
FORMA
|
FORM | string |
Especificar o formulário da despesa |
|
|
CHAVE
|
KEY | string |
Insira uma ID de registro de despesa válida para modificá-la |
|
|
Code
|
CODE | True | string |
Inserir um código de despesa |
|
Categoria de faturamento
|
LISOURCETYPE | True | string |
Selecione a categoria de faturamento (12 para 'Fornecedores', 13 para 'Clientes', 14 para 'Contas em dinheiro', 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 'Somente IVA') |
|
|
Nome
|
NAME | True | string |
Especificar 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 'Carimbo', 5 para 'Selo OGA') |
|
|
Grupo de IVA
|
VAT | True | string |
Selecione o grupo imposto sobre valor adicionado da despesa ou insira a ID do IVA |
Retornos
- Corpo
- setData200response
Inserir ou modificar documento de coleções
Inserir ou modificar os dados de um objeto de documento coleções identificado por uma CHAVE (ID do documento). Se a CHAVE estiver vazia ou não tiver um registro for inserida.
Parâmetros
| Nome | Chave | Obrigatório | Tipo | Description |
|---|---|---|---|---|
|
Cartão de crédito Nº.
|
CRDCARDNUM | string |
Inserir 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 a ID do cartão de crédito |
|
|
Linha de cartão de crédito Nº.
|
LINENUM | integer |
Especifique o número de linha do cartão de crédito ou deixe-o em branco por padrão |
|
|
Valor da linha de cartão
|
LINEVAL | integer |
Especificar o valor da linha do cartão |
|
|
Linha de dinheiro 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 |
Especificar o valor da linha de caixa |
|
|
Collector
|
COLLECTOR | string |
Selecione o Coletor ou insira a ID do Coletor |
|
|
Reason
|
COMMENTS | string |
Selecione o motivo ou insira a ID do motivo |
|
|
Projeto
|
PRJC | string |
Selecione o projeto ou insira a ID do projeto |
|
|
Vendedor
|
SALESMAN | string |
Selecione o Vendedor ou insira a ID do Vendedor |
|
|
Série
|
SERIES | True | string |
Selecione a série do documento ou insira a ID da série |
|
Customer
|
TRDR | True | string |
Selecione o Cliente ou insira a ID do Cliente |
|
Data da transação
|
TRNDATE | string |
Especificar a data da transação no formato YYYY-MM-DD ou deixá-la em branco por hoje |
|
|
Cheque Nº.
|
CCHEQUENUMBER | string |
Inserir cheque Nº. |
|
|
Data de conclusão do cheque
|
CFINALDATE | date-time |
Especifique a data de conclusão do cheque com o formato: YYYY-MM-DD ou deixe-a em branco para a data de hoje |
|
|
Cheque
|
CODE | string |
Inserir código de cheque |
|
|
Série cheques
|
CSERIES | integer |
Selecione a série de cheques ou insira a ID da série de cheques |
|
|
Número da linha de cheque
|
LINENUM | integer |
Especifique o número da linha de cheque ou deixe-o em branco por padrão |
|
|
Valor da linha de cheque
|
LINEVAL | integer |
Especificar o valor da linha de cheque |
|
|
Tipo de transação de cheque
|
TPRMS | integer |
Selecione o tipo de transação ou insira a ID do tipo de transação |
|
|
FORMA
|
FORM | string |
Especificar o formulário do documento |
|
|
CHAVE
|
KEY | string |
Insira uma ID de registro de documento válida para modificá-la |
Retornos
- Corpo
- setData200response
Inserir ou modificar documento de compras
Inserir ou modificar os dados de um objeto de documento de compra identificado por um KEY (ID do documento). Se a CHAVE estiver vazia ou não tiver um registro for inserida.
Parâmetros
| Nome | Chave | Obrigatório | Tipo | Description |
|---|---|---|---|---|
|
Desconto
|
DISC1PRC | integer |
Especificar o desconto do item |
|
|
Linha Não
|
LINENUM | string |
Especifique o número de 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 a ID do item |
|
|
Preço
|
PRICE | string |
Especificar o preço do item |
|
|
Quantidade
|
QTY | integer |
Especificar a quantidade do item |
|
|
Armazém
|
WHOUSE | True | string |
Selecione o warehouse ou insira a ID do warehouse |
|
Desconto
|
DISC1PRC | string |
Especificar o desconto do documento |
|
|
Pagamento
|
PAYMENT | string |
Selecione a forma de pagamento ou insira a ID de pagamento |
|
|
Projeto
|
PRJC | string |
Selecione o projeto ou insira a ID do projeto |
|
|
Comments
|
REMARKS | string |
Inserir comentários |
|
|
Série
|
SERIES | True | string |
Selecione a série do documento ou insira a ID da série |
|
Moeda
|
SOCURRENCY | True | string |
Selecione a moeda de pagamento ou insira a ID da moeda |
|
Total
|
SUMAMNT | string |
Especificar o valor total do documento |
|
|
Fornecedor
|
TRDR | True | string |
Selecione o fornecedor ou insira a ID do fornecedor |
|
Data da transação
|
TRNDATE | string |
Especifique a data da transação no formato YYYY-MM-DD ou deixe-a em branco por hoje |
|
|
Desconto
|
DISC1PRC | integer |
Especificar o desconto do serviço |
|
|
Nº de linha:
|
LINENUM | string |
Especificar o número de linha do serviço ou deixá-lo em branco por padrão |
|
|
Valor da linha
|
LINEVAL | string |
Especificar o valor da linha do serviço |
|
|
Service
|
MTRL | string |
Selecione um serviço ou insira a ID do serviço |
|
|
Preço
|
PRICE | string |
Especificar o preço do serviço |
|
|
Quantidade
|
QTY | integer |
Especificar a quantidade do serviço |
|
|
FORMA
|
FORM | string |
Especificar o formulário do documento |
|
|
CHAVE
|
KEY | string |
Insira uma ID de registro de documento válida para modificá-la |
Retornos
- Corpo
- setData200response
Inserir ou modificar documento de despesas
Inserir ou modificar os dados de um objeto de documento expenses identificado por um KEY (ID do documento). Se a CHAVE estiver vazia ou não tiver um registro for inserida.
Parâmetros
| Nome | Chave | Obrigatório | Tipo | Description |
|---|---|---|---|---|
|
Linha Não
|
LINENUM | string |
Especifique o número de linha do item ou deixe-o em branco por padrão |
|
|
Valor da linha
|
LINEVAL | string |
Especificar o valor da linha da despesa |
|
|
Expense
|
MTRL | string |
Selecione uma despesa ou insira a ID da despesa |
|
|
IVA
|
VAT | string |
Selecione IVA ou insira a ID do IVA |
|
|
Projeto
|
PRJC | string |
Selecione o projeto ou insira a ID do projeto |
|
|
Comments
|
REMARKS | string |
Inserir comentários |
|
|
Série
|
SERIES | True | string |
Selecione a série do documento ou insira a ID da série |
|
Fornecedor
|
TRDR | True | string |
Selecione o Cliente ou insira a ID do Cliente |
|
Data da transação
|
TRNDATE | string |
Especifique a data da transação no formato YYYY-MM-DD ou deixe-a em branco por hoje |
|
|
FORMA
|
FORM | string |
Especificar o formulário do documento |
|
|
CHAVE
|
KEY | string |
Insira uma ID de registro de documento válida para modificá-la |
Retornos
- Corpo
- setData200response
Inserir ou modificar documento de estoque
Insira ou modifique os dados de um registro do Documento de Estoque, identificado por um KEY. Se a CHAVE estiver vazia ou ausente, um novo registro será criado
Parâmetros
| Nome | Chave | Obrigatório | Tipo | Description |
|---|---|---|---|---|
|
FORMA
|
FORM | string |
Especificar o formulário do documento |
|
|
CHAVE
|
KEY | string |
Insira uma ID de registro de documento válida para modificá-la |
|
|
Reason
|
COMMENTS | string |
Especificar o motivo do documento |
|
|
Comments
|
REMARKS | string |
Inserir comentários |
|
|
Série
|
SERIES | True | string |
Selecione a série do documento ou insira a ID da série |
|
Data da transação
|
TRNDATE | string |
Especifique a data da transação no formato YYYY-MM-DD ou deixe-a em branco por hoje |
|
|
Desconto
|
DISC1PRC | string |
Especificar o desconto do item |
|
|
Nº de linha:
|
LINENUM | string |
Especifique o número de 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 a ID do item |
|
|
Preço
|
PRICE | string |
Especificar o preço do item |
|
|
Quantidade
|
QTY | string |
Especificar a quantidade do item |
|
|
Armazém
|
WHOUSE | True | string |
Selecione o warehouse ou insira a ID do armazém |
Retornos
- Corpo
- setData200response
Inserir ou modificar documento de pagamentos
Inserir ou modificar os dados de um objeto de documento de pagamentos identificado por um KEY (ID do documento). Se a CHAVE estiver vazia ou não tiver um registro for inserida.
Parâmetros
| Nome | Chave | Obrigatório | Tipo | Description |
|---|---|---|---|---|
|
Cartão de crédito Nº.
|
CRDCARDNUM | string |
Especificar 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 uma ID de cartão de crédito |
|
|
Linha de cartão de crédito Nº.
|
LINENUM | integer |
Especifique o número de linha do cartão de crédito ou deixe-o em branco por padrão |
|
|
Valor da linha de cartão
|
LINEVAL | integer |
Especificar o valor da linha do cartão de crédito |
|
|
Linha de dinheiro 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 |
Especificar o valor da linha de caixa |
|
|
Projeto
|
PRJC | string |
Selecione o projeto ou insira a ID do projeto |
|
|
Comments
|
REMARKS | string |
Inserir comentários |
|
|
Série
|
SERIES | True | string |
Selecione a série do documento ou insira uma ID de série |
|
Fornecedor
|
TRDR | True | string |
Selecione o cliente ou insira a ID do cliente |
|
Data da transação
|
TRNDATE | string |
Especificar a data da transação no formato YYYY-MM-DD ou deixá-la em branco por hoje |
|
|
Cheque Nº.
|
CCHEQUENUMBER | string |
Inserir cheque Nº. |
|
|
Data de conclusão do cheque
|
CFINALDATE | date-time |
Especifique a data de conclusão do cheque com o formato: YYYY-MM-DD ou deixe-a em branco para a data de hoje |
|
|
Cheque
|
CODE | string |
Inserir código de cheque |
|
|
Série cheques
|
CSERIES | integer |
Selecione a série de cheques ou insira a ID da série de cheques |
|
|
Número da linha de cheque
|
LINENUM | integer |
Especifique o número da linha de cheque ou deixe-o em branco por padrão |
|
|
Valor da linha de cheque
|
LINEVAL | integer |
Especificar o valor da linha de cheque |
|
|
Tipo de transação de cheque
|
TPRMS | integer |
Selecione o tipo de transação ou insira a ID do tipo de transação |
|
|
FORMA
|
FORM | string |
Especificar o formulário do documento |
|
|
CHAVE
|
KEY | string |
Insira uma ID de registro de documento válida para modificá-la |
Retornos
- Corpo
- setData200response
Inserir ou modificar documento de vendas
Insira ou modifique os dados de um registro do Documento de Vendas, identificado por um KEY. Se a CHAVE estiver vazia ou ausente, um novo registro será criado
Parâmetros
| Nome | Chave | Obrigatório | Tipo | Description |
|---|---|---|---|---|
|
FORMA
|
FORM | string |
Especificar o formulário do documento |
|
|
CHAVE
|
KEY | string |
Insira uma ID de registro de documento válida para modificá-la |
|
|
Desconto
|
DISC1PRC | string |
Especificar o desconto do item |
|
|
Nº de linha:
|
LINENUM | string |
Especifique o número de 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 a ID do item |
|
|
Preço
|
PRICE | string |
Especificar o preço do item |
|
|
Quantidade
|
QTY | string |
Especificar a quantidade do item |
|
|
Armazém
|
WHOUSE | True | string |
Selecione o warehouse ou insira a ID do armazém |
|
Desconto
|
DISC1PRC | string |
Especificar o desconto do documento |
|
|
Valor do desconto
|
DISC1VAL | string |
Especificar o valor de desconto do documento |
|
|
Valor líquido
|
NETAMNT | string |
Especificar o valor líquido do documento |
|
|
Pagamento
|
PAYMENT | True | string |
Selecione a forma de pagamento ou insira a ID de pagamento |
|
Projeto
|
PRJC | string |
Selecione o projeto ou insira a ID do projeto |
|
|
Comments
|
REMARKS | string |
Inserir comentários |
|
|
Série
|
SERIES | True | string |
Selecione a série do documento ou insira a ID da série |
|
Moeda
|
SOCURRENCY | True | string |
Selecione a moeda de pagamento ou insira a ID da moeda |
|
Total
|
SUMAMNT | string |
Especificar o valor total do documento |
|
|
Customer
|
TRDR | True | string |
Selecione o Cliente ou insira a ID do Cliente |
|
Data da transação
|
TRNDATE | string |
Especifique a data da transação no formato YYYY-MM-DD ou deixe-a em branco por hoje |
|
|
IVA
|
VATAMNT | string |
Especificar o IVA Total do documento |
|
|
Desconto
|
DISC1PRC | integer |
Especificar o desconto do serviço |
|
|
Nº de linha:
|
LINENUM | string |
Especificar o número de linha do serviço ou deixá-lo em branco por padrão |
|
|
Valor da linha
|
LINEVAL | string |
Especificar o valor da linha do serviço |
|
|
Service
|
MTRL | string |
Selecione um serviço ou insira a ID do serviço |
|
|
Preço
|
PRICE | string |
Especificar o preço do serviço |
|
|
Quantidade
|
QTY | integer |
Especificar a quantidade do serviço |
Retornos
- Corpo
- setData200response
Inserir ou modificar email
Inserir ou modificar os dados de um objeto de email identificado por um KEY (ID de email). Se a CHAVE estiver vazia ou não tiver um registro for inserida.
Parâmetros
| Nome | Chave | Obrigatório | Tipo | Description |
|---|---|---|---|---|
|
Situação
|
ACTSTATUS | string |
Selecione o status (0 para 'Indiferente', 1 para '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 do email |
|
|
Série
|
SERIES | True | string |
Selecione a série do email ou insira a ID da série |
|
Data do email
|
TRNDATE | date-time |
Especifique a Data de Email no formato YYYY-MM-DD ou deixe-a em branco por hoje |
|
|
De (Enviar como)
|
FROMADDRESS | string |
Endereço de email do qual enviar emails (requer a permissão "Enviar como" ou "Enviar em nome de" para essa caixa de correio) |
|
|
Remetente
|
FROMNAME | string |
Especificar o nome do proprietário e do remetente da caixa de correio |
|
|
BCC
|
SOBCC | string |
Especificar endereços de email separados por ponto-e-vírgula como someone@softone.gr |
|
|
Corpo
|
SOBODY | string |
Especificar o corpo do email |
|
|
CC
|
SOCC | string |
Especificar endereços de email separados por ponto-e-vírgula como someone@softone.gr |
|
|
Para
|
SOTO | string |
Especificar endereços de email separados por ponto-e-vírgula como someone@softone.gr |
|
|
linha Não
|
LINENUM | string |
Especifique a linha Nº. do item anexado |
|
|
nome
|
NAME | string |
Especificar o nome do arquivo do item anexado |
|
|
url
|
SOFNAME | string |
Especificar o endereço de URL do item anexado |
|
|
FORMA
|
FORM | string |
Especificar a forma do email |
|
|
CHAVE
|
KEY | string |
Insira uma ID de registro de email válida para modificá-la |
Retornos
- Corpo
- setData200response
Inserir ou modificar fornecedor
Inserir ou modificar os dados de um objeto fornecedor identificado por um KEY (ID do fornecedor). Se a CHAVE estiver vazia ou não tiver um registro for inserida.
Parâmetros
| Nome | Chave | Obrigatório | Tipo | Description |
|---|---|---|---|---|
|
Banco
|
BANK | string |
Selecionar um banco |
|
|
IBAN
|
IBAN | string |
Inserir número da Conta Bancária Internacional |
|
|
Comentários de conta bancária
|
REMARKS | string |
Inserir comentários para esta conta bancária |
|
|
Endereço
|
ADDRESS | string |
Especificar o endereço primário do fornecedor |
|
|
T.R.No
|
AFM | string |
Especificar o número de registro de imposto do fornecedor |
|
|
City
|
CITY | string |
Especificar a cidade do fornecedor |
|
|
Code
|
CODE | True | string |
Inserir um código de fornecedor |
|
Área de localização
|
DISTRICT | string |
Especificar a área de localização do fornecedor |
|
|
Email
|
string |
Especificar o endereço de email do fornecedor |
||
|
FAX
|
FAX | string |
Especificar o número de fax do fornecedor |
|
|
Escritório de impostos
|
IRSDATA | string |
Selecione o escritório fiscal do fornecedor |
|
|
Profissão
|
JOBTYPETRD | string |
Especificar a profissão do fornecedor |
|
|
Nome
|
NAME | True | string |
Especificar o nome do fornecedor |
|
Telefone primário
|
PHONE01 | string |
Especificar o número de telefone primário do fornecedor |
|
|
Comments
|
REMARKS | string |
Inserir comentários |
|
|
ZIP
|
ZIP | string |
Especificar o cep do fornecedor |
|
|
FORMA
|
FORM | string |
Especificar o formulário do fornecedor |
|
|
CHAVE
|
KEY | string |
Insira uma ID de fornecedor válida para modificá-la |
Retornos
- Corpo
- setData200response
Inserir ou modificar item
Inserir ou modificar os dados de um objeto de item identificado por um KEY (ID do item). Se a CHAVE estiver vazia ou um registro ausente for inserido.ele os dados de um registro em um Objeto de Item identificado por uma CHAVE. Se a CHAVE estiver vazia ou não tiver um registro for inserida.
Parâmetros
| Nome | Chave | Obrigatório | Tipo | Description |
|---|---|---|---|---|
|
FORMA
|
FORM | string |
Especificar o formulário do item |
|
|
CHAVE
|
KEY | string |
Insira uma ID de registro de item válida para modificá-la |
|
|
Code
|
CODE | True | string |
Inserir um código de item |
|
Categoria comercial
|
MTRCATEGORY | string |
Especificar a categoria comercial do item |
|
|
Grupo de itens
|
MTRGROUP | string |
Selecione o grupo do item ou insira a ID do grupo do item |
|
|
Unidade base de medida
|
MTRUNIT1 | True | string |
Selecione o U.o.M do item ou insira a ID do U.o.M |
|
Nome
|
NAME | True | string |
Especificar o nome do item |
|
Preço de varejo
|
PRICER | string |
Especificar o preço de varejo do item |
|
|
Preço por atacado
|
PRICEW | string |
Especificar o preço de atacado do item |
|
|
Comments
|
REMARKS | string |
Inserir comentários |
|
|
Desconto
|
SODISCOUNT | string |
Especificar o desconto do item |
|
|
Grupo de IVA
|
VAT | True | string |
Selecione o grupo imposto sobre valor adicionado do item ou insira a ID do IVA |
Retornos
- Corpo
- setData200response
Inserir ou modificar o cliente
Inserir ou modificar os dados de um objeto de cliente identificado por um KEY (ID do cliente). Se a CHAVE estiver vazia ou não tiver um registro for inserida.
Parâmetros
| Nome | Chave | Obrigatório | Tipo | Description |
|---|---|---|---|---|
|
FORMA
|
FORM | string |
Especificar o formulário do cliente |
|
|
CHAVE
|
KEY | string |
Insira uma ID de cliente válida para modificá-la |
|
|
Endereço Primário
|
ADDRESS | string |
Especificar o endereço principal do cliente |
|
|
T.R.No
|
AFM | string |
Especificar o número de registro de imposto do cliente |
|
|
Áreas Geográficas
|
AREAS | string |
Selecione a área geográfica |
|
|
City
|
CITY | string |
Especificar a cidade do cliente |
|
|
Code
|
CODE | True | string |
Inserir um código do cliente |
|
Desconto
|
DISCOUNT | integer |
Especificar o desconto do cliente |
|
|
Área de Localização
|
DISTRICT | string |
Especificar a área de localização do cliente |
|
|
correio
|
string |
Especificar o endereço de email do cliente |
||
|
Fac-símile
|
FAX | string |
Especificar o número de fax do cliente |
|
|
Escritório de Impostos
|
IRSDATA | string |
Selecione o escritório fiscal do cliente |
|
|
Profissão
|
JOBTYPETRD | string |
Especificar a profissão do cliente |
|
|
Nome
|
NAME | True | string |
Especificar o nome do cliente |
|
Telefone Primário
|
PHONE01 | string |
Especificar o número de telefone primário do cliente |
|
|
Comments
|
REMARKS | string |
Inserir comentários |
|
|
Categoria de Imposto
|
VATSTS | string |
Selecione a categoria de imposto (0 para Isento, 1 para Normal, 2 para Reduzido) |
|
|
Zip
|
ZIP | string |
Especificar o cep do cliente |
Retornos
- Corpo
- setData200response
Inserir ou modificar projeto
Inserir ou modificar os dados de um Objeto de Projeto identificado por um KEY (ID do projeto). Se a CHAVE estiver vazia ou não tiver um registro for inserida.
Parâmetros
| Nome | Chave | Obrigatório | Tipo | Description |
|---|---|---|---|---|
|
FORMA
|
FORM | string |
Especificar o formulário do contato |
|
|
CHAVE
|
KEY | string |
Insira uma ID de contato válida para modificá-la |
|
|
Situação
|
ACTSTATUS | string |
Selecione o status (0 para 'Indiferente', 1 para 'Ser ativado', 2 para 'Em andamento', 3 para 'Concluído', 4 para 'Cancelado', 5 para 'Aguardando', 6 para 'Adiado') |
|
|
Code
|
CODE | True | string |
Inserir um código de contato |
|
Data de conclusão
|
FINALDATE | date-time |
Especifique a data de conclusão da tarefa no formato YYYY-MM-DD ou deixe-a em branco por hoje |
|
|
Data de início
|
FROMDATE | date-time |
Especifique a data em que a tarefa foi criada no formato YYYY-MM-DD ou deixe-a em branco por hoje |
|
|
Nome
|
NAME | True | string |
Especificar o nome do projeto |
|
Variação
|
PRJCRM | string |
Selecionar variação (0 para 'Project', 1 para 'Campanha', 2 para 'Oportunidade') |
|
|
Comments
|
REMARKS | string |
Inserir comentários |
|
|
linha Não
|
LINENUM | string |
Especifique a linha Nº. do item anexado |
|
|
nome
|
NAME | string |
Especificar o nome do arquivo do item anexado |
|
|
url
|
SOFNAME | string |
Especificar o endereço de URL do item anexado |
Retornos
- Corpo
- setData200response
Inserir ou modificar reunião
Inserir ou modificar os dados de um objeto de reunião identificado por um KEY (ID da reunião). Se a CHAVE estiver vazia ou não tiver um registro for inserida.
Parâmetros
| Nome | Chave | Obrigatório | Tipo | Description |
|---|---|---|---|---|
|
Operator
|
ACTOR | string |
Selecione o operador ou insira a ID do operador |
|
|
Contato do operador
|
ACTPRSN | string |
Selecione o contato do operador ou insira a ID de contato |
|
|
Situação
|
ACTSTATUS | string |
Selecione o status (0 para 'Indiferente', 1 para '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 reunião |
|
|
Data de conclusão
|
FINALDATE | date-time |
Especifique a data em que a reunião foi criada no formato YYYY-MM-DD ou deixe-a em branco por hoje |
|
|
Data de início
|
FROMDATE | date-time |
Especifique a data em que a reunião foi criada no formato YYYY-MM-DD ou deixe-a em branco por hoje |
|
|
Ordenado por
|
ORDEREDBY | string |
Selecione o ordenador ou insira a ID do ordenador |
|
|
Ordenado por contato
|
ORDPRSN | string |
Selecione o contato do ordenador ou insira a ID de contato |
|
|
Priority
|
PRIORITY | string |
Selecione prioridade ou insira uma ID de prioridade válida |
|
|
Projeto
|
PRJC | string |
Selecione o projeto ou insira a ID do projeto |
|
|
Comments
|
REMARKS | string |
Inserir comentários |
|
|
Série
|
SERIES | True | string |
Selecione a série da reunião ou insira a ID da série |
|
Customer
|
TRDR | string |
Selecione o cliente ou insira a ID do cliente |
|
|
Data de inserção
|
TRNDATE | date-time |
Especifique a data em que a reunião foi criada no formato YYYY-MM-DD ou deixe-a em branco por hoje |
|
|
linha Não
|
LINENUM | string |
Especifique a linha Nº. do item anexado |
|
|
nome
|
NAME | string |
Especificar o nome do arquivo do item anexado |
|
|
url
|
SOFNAME | string |
Especificar o endereço de URL do item anexado |
|
|
FORMA
|
FORM | string |
Especificar o formulário da reunião |
|
|
CHAVE
|
KEY | string |
Insira uma ID de registro de reunião válida para modificá-la |
Retornos
- Corpo
- setData200response
Inserir ou modificar serviço
Inserir ou modificar os dados de um objeto de serviço identificado por uma CHAVE (ID do Serviço). Se a CHAVE estiver vazia ou não tiver um registro for inserida.
Parâmetros
| Nome | Chave | Obrigatório | Tipo | Description |
|---|---|---|---|---|
|
FORMA
|
FORM | string |
Especificar o formulário do serviço |
|
|
CHAVE
|
KEY | string |
Insira uma ID de registro de serviço válida para modificá-la |
|
|
Code
|
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 a ID do grupo do serviço |
|
|
Unidade base de medida
|
MTRUNIT1 | True | string |
Selecione o U.o.M do serviço ou insira a ID do U.o.M |
|
Nome
|
NAME | True | string |
Especificar o nome do serviço |
|
Preço de varejo
|
PRICER | string |
Especificar o preço de varejo do serviço |
|
|
Preço por atacado
|
PRICEW | string |
Especificar o preço de atacado do serviço |
|
|
Comments
|
REMARKS | string |
Inserir comentários |
|
|
Desconto
|
SODISCOUNT | string |
Especificar o desconto do serviço |
|
|
Grupo de IVA
|
VAT | True | string |
Selecione o grupo imposto sobre valor adicionado do serviço ou insira a ID do IVA |
Retornos
- Corpo
- setData200response
Inserir ou modificar tarefa
Inserir ou modificar os dados de um objeto de tarefa identificado por um KEY (ID da tarefa). Se a CHAVE estiver vazia ou não tiver um registro for inserida.
Parâmetros
| Nome | Chave | Obrigatório | Tipo | Description |
|---|---|---|---|---|
|
Operator
|
ACTOR | string |
Selecione o operador ou insira a ID do operador |
|
|
Contato do operador
|
ACTPRSN | string |
Selecione o contato do operador ou insira a ID de contato |
|
|
Situação
|
ACTSTATUS | string |
Selecione o status (0 para 'Indiferente', 1 para '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 conclusão
|
FINALDATE | date-time |
Especifique a data de conclusão da tarefa no formato YYYY-MM-DD ou deixe-a em branco por hoje |
|
|
Data de início
|
FROMDATE | date-time |
Especifique a data em que a tarefa foi criada no formato YYYY-MM-DD ou deixe-a em branco por hoje |
|
|
Ordenado por
|
ORDEREDBY | string |
Selecione o ordenador ou insira a ID do ordenador |
|
|
Ordenado por contato
|
ORDPRSN | string |
Selecione o contato do ordenador ou insira a ID de contato |
|
|
Priority
|
PRIORITY | string |
Selecione prioridade ou insira uma ID de prioridade válida |
|
|
Projeto
|
PRJC | string |
Selecione o projeto ou insira a ID do projeto |
|
|
Comments
|
REMARKS | string |
Inserir comentários |
|
|
Série
|
SERIES | True | string |
Selecione a série da tarefa ou insira a ID da série |
|
Customer
|
TRDR | string |
Selecione o cliente ou insira a ID do cliente |
|
|
Data de inserção
|
TRNDATE | date-time |
Especifique a data em que a tarefa foi criada no formato YYYY-MM-DD ou deixe-a em branco por hoje |
|
|
linha Não
|
LINENUM | string |
Especifique a linha Nº. do item anexado |
|
|
nome
|
NAME | string |
Especificar o nome do arquivo do item anexado |
|
|
url
|
SOFNAME | string |
Especificar o endereço de URL do item anexado |
|
|
FORMA
|
FORM | string |
Especificar o formulário da tarefa |
|
|
CHAVE
|
KEY | string |
Insira uma ID de registro de tarefa válida para modificá-la |
Retornos
- Corpo
- setData200response
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.
Parâmetros
| Nome | Chave | Obrigatório | Tipo | Description |
|---|---|---|---|---|
|
Corpo
|
body | True | string |
Inserir corpo da solicitação |
|
Ponto final
|
endpoint | True | string |
Especificar o ponto de extremidade da URL do serviço Web |
Obter Cheque
Retorna todos os dados (ou os selecionados de LOCATEINFO) de um registro de um objeto Cheque
Parâmetros
| Nome | Chave | Obrigatório | Tipo | Description |
|---|---|---|---|---|
|
FORMA
|
FORM | string |
Especificar o formulário do cheque |
|
|
CHAVE
|
KEY | True | string |
Inserir uma ID de registro de cheque válida |
|
LOCATEINFO
|
LOCATEINFO | True | string |
Especificar os campos desejados do cheque |
Retornos
| Nome | Caminho | Tipo | Description |
|---|---|---|---|
|
Legenda
|
caption | string |
Legenda descritiva do registro 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 |
O código bancário do cheque |
|
nome do banco
|
data.CHEQUE.BANK_BANK_NAME | string |
O nome do banco do cheque |
|
saldo
|
data.CHEQUE.CHEQUEBAL | string |
O saldo do cheque |
|
número
|
data.CHEQUE.CHEQUENUMBER | string |
O número do cheque |
|
estado
|
data.CHEQUE.CHEQUESTATES | string |
O estado do cheque |
|
value
|
data.CHEQUE.CHEQUEVAL | string |
O valor do cheque |
|
empresa
|
data.CHEQUE.COMPANY | string |
A empresa do cheque |
|
endereço do emissor
|
data.CHEQUE.CREATORADDR | string |
O endereço do emissor do cheque |
|
nome do emissor
|
data.CHEQUE.CREATORNAME | string |
O nome do emissor do cheque |
|
telefone emissor
|
data.CHEQUE.CREATORPHONE | string |
O telefone emissor do cheque |
|
data de recebimento
|
data.CHEQUE.CRTDATE | string |
A data de recebimento do cheque |
|
data do problema
|
data.CHEQUE.DATEOFS | string |
A data de emissão do cheque |
|
data de conclusão
|
data.CHEQUE.FINALDATE | date-time |
A data de conclusão do cheque |
|
endereço do titular
|
data.CHEQUE.HOLDERADDR | string |
O endereço do titular do cheque |
|
nome do titular
|
data.CHEQUE.HOLDERNAME | string |
O nome do titular do cheque |
|
T.R.No do emissor
|
data.CHEQUE.PUBLISHERAFM | string |
O número de registro de imposto 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 holder
|
data.CHEQUE.TRDRPOSSESSOR_TRDR_CODE | string |
O código do titular do cheque |
|
código do emissor
|
data.CHEQUE.TRDRPUBLISHER_TRDR_CODE | string |
O código do emissor do cheque |
|
Erro
|
error | string |
Mensagem de erro se a ação não tiver êxito |
|
Código do erro
|
errorcode | integer |
Código de erro se a ação não tiver êxito |
|
Êxito
|
success | boolean |
A ação foi bem-sucedida? |
Obter Cliente
Retorna todos os dados (ou os selecionados de LOCATEINFO) de um registro de um Objeto do Cliente.
Parâmetros
| Nome | Chave | Obrigatório | Tipo | Description |
|---|---|---|---|---|
|
FORMA
|
FORM | string |
Especificar o formulário do cliente |
|
|
CHAVE
|
KEY | True | string |
Inserir uma ID de registro de cliente válida |
|
LOCATEINFO
|
LOCATEINFO | True | string |
Especificar os campos de dados desejados pelo cliente |
Retornos
| Nome | Caminho | Tipo | Description |
|---|---|---|---|
|
Legenda
|
caption | string |
Uma legenda descritiva do registro. |
|
Chave Remota
|
remoteKey | string |
ID do aplicativo de terceiros |
|
Endereço primário
|
data.CUSTOMER.ADDRESS | string |
O endereço principal do cliente |
|
T.R.No
|
data.CUSTOMER.AFM | string |
número de registro de imposto do cliente |
|
área geográfica
|
data.CUSTOMER.AREAS | string |
A área geográfica do cliente |
|
city
|
data.CUSTOMER.CITY | string |
A cidade do cliente |
|
Code
|
data.CUSTOMER.CODE | string |
Código do cliente |
|
discount (%)
|
data.CUSTOMER.DISCOUNT | string |
Percentual (%) desconto do cliente |
|
área de localização
|
data.CUSTOMER.DISTRICT | string |
A área de localização do cliente |
|
correio
|
data.CUSTOMER.EMAIL | string |
O endereço de email do cliente |
|
fax
|
data.CUSTOMER.FAX | string |
O número de FAX do cliente |
|
tax Office
|
data.CUSTOMER.IRSDATA | string |
O escritório fiscal do cliente |
|
Active
|
data.CUSTOMER.ISACTIVE | string |
O cliente está ativo? |
|
profissão
|
data.CUSTOMER.JOBTYPETRD | string |
A profissão do cliente |
|
nome
|
data.CUSTOMER.NAME | string |
O nome do cliente |
|
telefone primário
|
data.CUSTOMER.PHONE01 | string |
O número de telefone primário do cliente |
|
comments
|
data.CUSTOMER.REMARKS | string |
Comentários sobre o registro do cliente |
|
categoria de imposto
|
data.CUSTOMER.VATSTS | string |
A categoria de imposto do cliente |
|
zip
|
data.CUSTOMER.ZIP | string |
O cep do cliente |
|
Erro
|
error | string |
Mensagem de erro se a ação não tiver êxito |
|
Código do erro
|
errorcode | integer |
Código de erro se a ação não tiver êxito |
|
Êxito
|
success | boolean |
A ação foi bem-sucedida? |
Obter contato
Retorna todos os dados (ou os selecionados de LOCATEINFO) de um registro de um objeto de contato
Parâmetros
| Nome | Chave | Obrigatório | Tipo | Description |
|---|---|---|---|---|
|
FORMA
|
FORM | string |
Especificar o formulário do contato |
|
|
CHAVE
|
KEY | True | string |
Inserir uma ID de registro de contato válida |
|
LOCATEINFO
|
LOCATEINFO | True | string |
Especificar os campos de dados desejados do documento |
Retornos
| Nome | Caminho | Tipo | Description |
|---|---|---|---|
|
Legenda
|
caption | string |
Breve legenda do registro de contato |
|
Chave Remota
|
remoteKey | string |
ID do aplicativo de terceiros |
|
address
|
data.PRSNOUT.ADDRESS | string |
O endereço do contato |
|
T.R.No
|
data.PRSNOUT.AFM | string |
Número de registro do imposto do contato |
|
área geográfica
|
data.PRSNOUT.AREAS | string |
A ID e o nome da área geográfica do contato |
|
Data de nascimento
|
data.PRSNOUT.BIRTHDATE | string |
A data de nascimento do contato |
|
branch
|
data.PRSNOUT.BRANCH | string |
O nome e a ID do branch do contato |
|
city
|
data.PRSNOUT.CITY | string |
A cidade do contato |
|
codificar
|
data.PRSNOUT.CODE | string |
O código do contato |
|
country
|
data.PRSNOUT.COUNTRY | string |
A ID e o nome do país do contato |
|
distrito
|
data.PRSNOUT.DISTRICT | string |
A área de localização do contato |
|
primeiro email
|
data.PRSNOUT.EMAIL | string |
O primeiro endereço de email do contato |
|
segundo email
|
data.PRSNOUT.EMAIL1 | string |
O segundo endereço de email do contato |
|
fax
|
data.PRSNOUT.FAX | string |
O número de fax do contato |
|
Cartão de ID Não
|
data.PRSNOUT.IDENTITYNUM | string |
O número do cartão de ID do contato |
|
escritório de impostos
|
data.PRSNOUT.IRSDATA | string |
O escritório fiscal do contato |
|
Active
|
data.PRSNOUT.ISACTIVE | string |
O contato está ativo? |
|
telemóvel
|
data.PRSNOUT.MOBILEPHONE | string |
Telefone celular do contato |
|
nome
|
data.PRSNOUT.NAME | string |
O nome do contato |
|
surname
|
data.PRSNOUT.NAME2 | string |
O sobrenome do contato |
|
nacionalidade
|
data.PRSNOUT.NATIONALITY | string |
A ID e o nome da nacionalidade do contato |
|
Tel. 1
|
data.PRSNOUT.PHONE1 | string |
O primeiro número de telefone do contato |
|
Tel. 2
|
data.PRSNOUT.PHONE2 | string |
O segundo número de telefone do contato |
|
telefone interno
|
data.PRSNOUT.PHONEEXT | string |
Telefone interno do contato |
|
telefone pessoal
|
data.PRSNOUT.PHONELOCAL | string |
Telefone residencial do contato |
|
comments
|
data.PRSNOUT.REMARKS | string |
Comentários do contato |
|
gender
|
data.PRSNOUT.SOSEX | string |
O gênero do contato |
|
página web
|
data.PRSNOUT.WEBPAGE | string |
A página da Web do contato |
|
zip
|
data.PRSNOUT.ZIP | string |
Cep do contato |
|
Item anexado
|
data.XTRDOCDATA | array of object |
Matriz de dados de itens anexados |
|
linha Nº.
|
data.XTRDOCDATA.LINENUM | string |
Número de linha do item anexado |
|
nome
|
data.XTRDOCDATA.NAME | string |
Nome do arquivo do item anexado |
|
url
|
data.XTRDOCDATA.SOFNAME | string |
Endereço de URL do item anexado |
|
Erro
|
error | string |
Mensagem de erro se a ação não tiver êxito |
|
Código do erro
|
errorcode | integer |
Código de erro se a ação não tiver êxito |
|
Êxito
|
success | boolean |
A ação foi bem-sucedida? |
Obter despesas
Retorna todos os dados (ou os selecionados de LOCATEINFO) de um registro de um Objeto expense.
Parâmetros
| Nome | Chave | Obrigatório | Tipo | Description |
|---|---|---|---|---|
|
FORMA
|
FORM | string |
Especificar o formulário da despesa |
|
|
CHAVE
|
KEY | True | string |
Inserir uma ID de registro de despesas válida |
|
LOCATEINFO
|
LOCATEINFO | True | string |
Especificar os campos desejados do serviço |
Retornos
| Nome | Caminho | Tipo | Description |
|---|---|---|---|
|
Legenda
|
caption | string |
Legenda descritiva do registro da despesa |
|
Chave Remota
|
remoteKey | string |
ID do aplicativo de terceiros |
|
codificar
|
data.LINEITEM.CODE | string |
O código da despesa |
|
Active
|
data.LINEITEM.ISACTIVE | string |
As despesas estão ativas? |
|
Categoria de faturamento
|
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 da 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 |
O valor da taxa da despesa |
|
Grupo de IVA
|
data.LINEITEM.VAT | string |
O imposto sobre o valor adicionado da despesa |
|
Erro
|
error | string |
Mensagem de erro se a ação não tiver êxito |
|
Código do erro
|
errorcode | integer |
Código de erro se a ação não tiver êxito |
|
Êxito
|
success | boolean |
A ação foi bem-sucedida? |
Obter documento de coleções
Retorna todos os dados (ou os selecionados de LOCATEINFO) de um registro de um Objeto Collections.
Parâmetros
| Nome | Chave | Obrigatório | Tipo | Description |
|---|---|---|---|---|
|
FORMA
|
FORM | string |
Especificar o formulário do documento |
|
|
CHAVE
|
KEY | True | string |
Inserir uma ID de registro de documento válida |
|
LOCATEINFO
|
LOCATEINFO | True | string |
Especificar os campos de dados desejados do documento |
Retornos
| Nome | Caminho | Tipo | Description |
|---|---|---|---|
|
Legenda
|
caption | string |
Legenda descritiva do registro 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 |
O nome e a ID do cartão de crédito |
|
número de 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 do cartão de crédito |
|
Desconta
|
data.CASHLINES | array of object |
Caixas de matriz de dados |
|
linha Nº.
|
data.CASHLINES.LINENUM | string |
O número da linha do dinheiro |
|
valor da linha
|
data.CASHLINES.LINEVAL | string |
O valor da linha do dinheiro |
|
moeda
|
data.CASHLINES.SOCURRENCY | string |
A moeda do dinheiro |
|
coletor
|
data.CFNCUSDOC.COLLECTOR | string |
A ID do coletor do documento |
|
sobrenome do coletor
|
data.CFNCUSDOC.COLLECTOR_PRSNIN_NAME2 | string |
O sobrenome do coletor do documento |
|
empresa
|
data.CFNCUSDOC.COMPANY | string |
O nome e a ID da empresa do documento |
|
codificar
|
data.CFNCUSDOC.FINCODE | string |
O código do documento |
|
projeto
|
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 |
A ID do vendedor do documento |
|
sobrenome do vendedor
|
data.CFNCUSDOC.SALESMAN_PRSNIN_NAME2 | string |
O sobrenome do vendedor do documento |
|
série
|
data.CFNCUSDOC.SERIES | string |
A série do documento |
|
total
|
data.CFNCUSDOC.SUMAMNT | string |
O valor total do documento |
|
cliente
|
data.CFNCUSDOC.TRDR | string |
A ID do cliente do documento |
|
código do cliente
|
data.CFNCUSDOC.TRDR_TRDR_CODE | string |
O código do cliente do documento |
|
nome do cliente
|
data.CFNCUSDOC.TRDR_TRDR_NAME | string |
O 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 Cheques |
|
data de conclusão
|
data.CHEQUELINES.CFINALDATE | date-time |
CFINALDATE |
|
codificar
|
data.CHEQUELINES.CODE | string |
CÓDIGO |
|
série
|
data.CHEQUELINES.CSERIES | string |
CSERIES |
|
número de 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 tiver êxito |
|
Código do erro
|
errorcode | integer |
Código de erro se a ação não tiver êxito |
|
Êxito
|
success | boolean |
A ação foi bem-sucedida? |
Obter documento de compras
Retorna todos os dados (ou os selecionados de LOCATEINFO) de um registro de um Objeto de Compra.
Parâmetros
| Nome | Chave | Obrigatório | Tipo | Description |
|---|---|---|---|---|
|
FORMA
|
FORM | string |
Especificar o formulário do documento |
|
|
CHAVE
|
KEY | True | string |
Inserir uma ID de registro de documento válida |
|
LOCATEINFO
|
LOCATEINFO | True | string |
Especificar os campos de dados desejados do documento |
Retornos
| Nome | Caminho | Tipo | Description |
|---|---|---|---|
|
Legenda
|
caption | string |
Breve legenda do registro 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 de item do documento |
|
número de linha
|
data.ITELINES.LINENUM | string |
O número da linha de item do documento |
|
value
|
data.ITELINES.LINEVAL | string |
O valor da linha de item do documento |
|
ID
|
data.ITELINES.MTRL | string |
ID do item do documento |
|
codificar
|
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 |
|
price
|
data.ITELINES.PRICE | string |
Preço do item do documento |
|
quantidade
|
data.ITELINES.QTY | string |
Quantidade de item do documento |
|
Empresa
|
data.MTRDOC.COMPANY | string |
A ID da empresa do documento |
|
Data de entrega
|
data.MTRDOC.DELIVDATE | date-time |
A data de entrega do documento |
|
Endereço de entrega
|
data.MTRDOC.SHIPPINGADDR | string |
O endereço de envio do documento |
|
Armazém
|
data.MTRDOC.WHOUSE | string |
O nome e a ID do armazém do documento |
|
empresa
|
data.PURDOC.COMPANY | string |
O nome e a ID da empresa do documento |
|
discount (%)
|
data.PURDOC.DISC1PRC | string |
O percentual do documento(%) desconto |
|
valor de desconto
|
data.PURDOC.DISC1VAL | string |
O valor de desconto do documento |
|
Despesas
|
data.PURDOC.EXPN | string |
Despesas do documento |
|
codificar
|
data.PURDOC.FINCODE | string |
O código do documento |
|
tipo
|
data.PURDOC.FPRMS | string |
O tipo do documento |
|
valor líquido
|
data.PURDOC.NETAMNT | string |
O valor líquido do documento |
|
pagamento
|
data.PURDOC.PAYMENT | string |
A forma de pagamento do documento |
|
projeto
|
data.PURDOC.PRJC | string |
A ID do projeto do documento |
|
código do projeto
|
data.PURDOC.PRJC_PRJC_CODE | string |
O 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 |
O valor total do documento |
|
ID do fornecedor
|
data.PURDOC.TRDR | string |
A ID do fornecedor do documento |
|
endereço do fornecedor
|
data.PURDOC.TRDR_SUPPLIER_ADDRESS | string |
O endereço do fornecedor do documento |
|
T.R.No do fornecedor
|
data.PURDOC.TRDR_SUPPLIER_AFM | string |
O fornecedor do documento registro de imposto nº. |
|
código de fornecedor
|
data.PURDOC.TRDR_SUPPLIER_CODE | string |
O código do fornecedor do documento |
|
escritório de impostos do fornecedor
|
data.PURDOC.TRDR_SUPPLIER_IRSDATA | string |
O escritório de impostos sobre fornecedores 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 |
O nome do fornecedor do documento |
|
telefone fornecedor
|
data.PURDOC.TRDR_SUPPLIER_PHONE01 | string |
O número de telefone do fornecedor do documento |
|
data da transação
|
data.PURDOC.TRNDATE | date-time |
A data da transação do documento |
|
Valor do IVA
|
data.PURDOC.VATAMNT | string |
O valor do Imposto sobre Valor Adicionado do documento |
|
Services
|
data.SRVLINES | array of object |
Matriz de dados de serviços |
|
desconto
|
data.SRVLINES.DISC1PRC | string |
O desconto do serviço do documento |
|
número de linha
|
data.SRVLINES.LINENUM | string |
O número da linha de serviço do documento |
|
value
|
data.SRVLINES.LINEVAL | string |
O valor da linha de serviço do documento |
|
ID
|
data.SRVLINES.MTRL | string |
A ID do serviço do documento |
|
codificar
|
data.SRVLINES.MTRL_SERVICE_CODE | date-time |
Código do serviço do documento |
|
nome
|
data.SRVLINES.MTRL_SERVICE_NAME | string |
O nome do serviço do documento |
|
price
|
data.SRVLINES.PRICE | string |
O preço do serviço do documento |
|
quantidade
|
data.SRVLINES.QTY | string |
Quantidade de serviço do documento |
|
Análise de IVA
|
data.VATANAL | array of object |
Matriz de análise de IVA |
|
valor sujeito ao IVA
|
data.VATANAL.SUBVAL | string |
Valor total do documento sujeito à categoria de IVA |
|
ID e categoria
|
data.VATANAL.VAT | string |
ID da categoria de IVA |
|
value
|
data.VATANAL.VATVAL | string |
Valor total da categoria de IVA |
|
percent(%)
|
data.VATANAL.VAT_VAT_PERCNT | string |
Porcentagem da categoria de IVA (%) |
|
Erro
|
error | string |
Mensagem de erro se a ação não tiver êxito |
|
Código do erro
|
errorcode | integer |
Código de erro se a ação não tiver êxito |
|
Êxito
|
success | boolean |
A ação foi bem-sucedida? |
Obter documento de despesas
Retorna todos os dados (ou os selecionados de LOCATEINFO) de um registro de um Objeto Expenses.
Parâmetros
| Nome | Chave | Obrigatório | Tipo | Description |
|---|---|---|---|---|
|
FORMA
|
FORM | string |
Especificar o formulário do documento |
|
|
CHAVE
|
KEY | True | string |
Inserir uma ID de registro de documento válida |
|
LOCATEINFO
|
LOCATEINFO | string |
Especificar os campos de dados desejados do documento |
Retornos
| Nome | Caminho | Tipo | Description |
|---|---|---|---|
|
Legenda
|
caption | string |
Legenda descritiva do registro do documento |
|
Chave Remota
|
remoteKey | string |
ID do aplicativo de terceiros |
|
Despesas
|
data.LINLINES | array of object |
Matriz de dados de despesas |
|
número de 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 das despesas do documento |
|
codificar
|
data.LINLINES.MTRL_ITEM_CODE | string |
Código das despesas do documento |
|
nome
|
data.LINLINES.MTRL_ITEM_NAME | string |
O nome da despesa do documento |
|
ID do IVA
|
data.LINLINES.VAT | string |
ID do imposto sobre valor adicionado de despesas do documento |
|
Valor do IVA
|
data.LINLINES.VATAMNT | string |
O valor do imposto sobre o valor adicionado da despesa do documento |
|
empresa
|
data.LINSUPDOC.COMPANY | string |
ID e nome da empresa do documento |
|
codificar
|
data.LINSUPDOC.FINCODE | string |
O código do documento |
|
pagamento
|
data.LINSUPDOC.PAYMENT | string |
A forma de pagamento do documento |
|
série
|
data.LINSUPDOC.SERIES | string |
A série do documento |
|
moeda
|
data.LINSUPDOC.SOCURRENCY | string |
A moeda de pagamento do documento |
|
total
|
data.LINSUPDOC.SUMAMNT | string |
O valor total do documento |
|
ID do fornecedor
|
data.LINSUPDOC.TRDR | string |
A ID do fornecedor do documento |
|
T.R.No do fornecedor
|
data.LINSUPDOC.TRDR_SUPPLIER_AFM | string |
Número de registro de imposto do fornecedor do documento |
|
nome do fornecedor
|
data.LINSUPDOC.TRDR_SUPPLIER_NAME | string |
O nome do fornecedor do documento |
|
data da transação
|
data.LINSUPDOC.TRNDATE | date-time |
Data da transação do documento |
|
Valor do IVA
|
data.LINSUPDOC.VATAMNT | string |
O valor do Imposto sobre Valor Adicionado do documento |
|
Erro
|
error | string |
Mensagem de erro se a ação não tiver êxito |
|
Código do erro
|
errorcode | integer |
Código de erro se a ação não tiver êxito |
|
Êxito
|
success | boolean |
A ação foi bem-sucedida? |
Obter documento de estoque
Retorna todos os dados (ou os selecionados de LOCATEINFO) de um registro de um objeto de documento de estoque.
Parâmetros
| Nome | Chave | Obrigatório | Tipo | Description |
|---|---|---|---|---|
|
FORMA
|
FORM | string |
Especificar o formulário do documento |
|
|
CHAVE
|
KEY | True | string |
Inserir uma ID de registro de documento válida |
|
LOCATEINFO
|
LOCATEINFO | True | string |
Especificar os campos de dados desejados do documento |
Retornos
| Nome | Caminho | Tipo | Description |
|---|---|---|---|
|
Legenda
|
caption | string |
Legenda descritiva do registro do documento |
|
Chave Remota
|
remoteKey | string |
ID do aplicativo de terceiros |
|
reason
|
data.ITEDOC.COMMENTS | string |
O motivo do documento |
|
empresa
|
data.ITEDOC.COMPANY | string |
ID e nome da empresa do documento |
|
codificar
|
data.ITEDOC.FINCODE | string |
O código do documento |
|
comments
|
data.ITEDOC.REMARKS | string |
Comentários do documento |
|
série
|
data.ITEDOC.SERIES | string |
A série do documento |
|
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 de item do documento |
|
número de linha
|
data.ITELINES.LINENUM | string |
A linha de item nº do documento. |
|
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 |
|
codificar
|
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 |
|
price
|
data.ITELINES.PRICE | string |
Preço do item do documento |
|
quantidade
|
data.ITELINES.QTY | string |
Quantidade de item do documento |
|
Empresa
|
data.MTRDOC.COMPANY | string |
A ID da empresa do documento |
|
Data de entrega
|
data.MTRDOC.DELIVDATE | date-time |
A data de entrega do documento |
|
Endereço de entrega
|
data.MTRDOC.SHIPPINGADDR | string |
O endereço de envio do documento |
|
Armazém
|
data.MTRDOC.WHOUSE | string |
O nome e a ID do armazém do documento |
|
Erro
|
error | string |
Mensagem de erro se a ação não tiver êxito |
|
Código do erro
|
errorcode | integer |
Código de erro se a ação não tiver êxito |
|
Êxito
|
success | boolean |
A ação foi bem-sucedida? |
Obter documento de pagamentos
Retorna todos os dados (ou os selecionados de LOCATEINFO) de um registro de um Objeto de Pagamento.
Parâmetros
| Nome | Chave | Obrigatório | Tipo | Description |
|---|---|---|---|---|
|
FORMA
|
FORM | string |
Especificar o formulário do documento |
|
|
CHAVE
|
KEY | True | string |
Inserir uma ID de registro de documento válida |
|
LOCATEINFO
|
LOCATEINFO | True | string |
Especificar os campos de dados desejados do documento |
Retornos
| Nome | Caminho | Tipo | Description |
|---|---|---|---|
|
Legenda
|
caption | string |
Legenda descritiva do registro 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 |
O nome e a ID do cartão de crédito |
|
número de 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 do cartão de crédito |
|
Desconta
|
data.CASHLINES | array of object |
Caixas de matriz de dados |
|
número de linha
|
data.CASHLINES.LINENUM | string |
O número da linha do dinheiro |
|
valor da linha
|
data.CASHLINES.LINEVAL | string |
O valor da linha do dinheiro |
|
moeda de linha
|
data.CASHLINES.SOCURRENCY | string |
A moeda do dinheiro |
|
reason
|
data.CFNSUPDOC.COMMENTS | string |
O motivo do documento |
|
empresa
|
data.CFNSUPDOC.COMPANY | string |
O nome e a ID da empresa do documento |
|
codificar
|
data.CFNSUPDOC.FINCODE | string |
O código do documento |
|
projeto
|
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 |
A série do documento |
|
total
|
data.CFNSUPDOC.SUMAMNT | string |
O valor total do documento |
|
fornecedor
|
data.CFNSUPDOC.TRDR | string |
A ID do fornecedor do documento |
|
endereço do fornecedor
|
data.CFNSUPDOC.TRDR_TRDR_ADDRESS | string |
O endereço do fornecedor do documento |
|
T.R.No do fornecedor
|
data.CFNSUPDOC.TRDR_TRDR_AFM | string |
Número de registro de imposto do fornecedor do documento (T.R.No) |
|
código de fornecedor
|
data.CFNSUPDOC.TRDR_TRDR_CODE | string |
O código do fornecedor do documento |
|
escritório de impostos sobre fornecedores
|
data.CFNSUPDOC.TRDR_TRDR_IRSDATA | string |
O escritório de impostos sobre fornecedores do documento |
|
nome do fornecedor
|
data.CFNSUPDOC.TRDR_TRDR_NAME | string |
O 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 Cheques |
|
data de conclusão
|
data.CHEQUELINES.CFINALDATE | date-time |
CFINALDATE |
|
codificar
|
data.CHEQUELINES.CODE | string |
CÓDIGO |
|
série
|
data.CHEQUELINES.CSERIES | string |
CSERIES |
|
número de 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 tiver êxito |
|
Código do erro
|
errorcode | integer |
Código de erro se a ação não tiver êxito |
|
Êxito
|
success | boolean |
A ação foi bem-sucedida? |
Obter Documento de Vendas
Retorna todos os dados (ou os selecionados de LOCATEINFO) de um registro de um Objeto de Vendas.
Parâmetros
| Nome | Chave | Obrigatório | Tipo | Description |
|---|---|---|---|---|
|
FORMA
|
FORM | string |
Especificar o formulário do documento |
|
|
CHAVE
|
KEY | True | string |
Inserir uma ID de registro de documento válida |
|
LOCATEINFO
|
LOCATEINFO | True | string |
Especificar os campos de dados desejados do documento |
Retornos
| Nome | Caminho | Tipo | Description |
|---|---|---|---|
|
Legenda
|
caption | string |
Legenda descritiva do registro 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 de item do documento |
|
número de linha
|
data.ITELINES.LINENUM | string |
A linha de item nº do documento. |
|
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 |
|
codificar
|
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 |
|
price
|
data.ITELINES.PRICE | string |
Preço do item do documento |
|
quantidade
|
data.ITELINES.QTY | string |
Quantidade de item do documento |
|
Empresa
|
data.MTRDOC.COMPANY | string |
A ID da empresa do documento |
|
Data de entrega
|
data.MTRDOC.DELIVDATE | date-time |
A data de entrega do documento |
|
Endereço de entrega
|
data.MTRDOC.SHIPPINGADDR | string |
O endereço de envio do documento |
|
Armazém
|
data.MTRDOC.WHOUSE | string |
O nome e a ID do armazém do documento |
|
empresa
|
data.SALDOC.COMPANY | string |
O nome e a ID da empresa do documento |
|
discount (%)
|
data.SALDOC.DISC1PRC | string |
O percentual do documento(%) desconto |
|
valor de desconto
|
data.SALDOC.DISC1VAL | string |
O valor de desconto do documento |
|
Despesas
|
data.SALDOC.EXPN | string |
Despesas do documento |
|
codificar
|
data.SALDOC.FINCODE | string |
O código do documento |
|
tipo
|
data.SALDOC.FPRMS | string |
O tipo do documento |
|
valor líquido
|
data.SALDOC.NETAMNT | string |
O valor líquido do documento |
|
pagamento
|
data.SALDOC.PAYMENT | string |
A forma de pagamento do documento |
|
comments
|
data.SALDOC.REMARKS | string |
Comentários do documento |
|
série
|
data.SALDOC.SERIES | string |
A série do documento |
|
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 |
O valor total do documento |
|
ID do cliente
|
data.SALDOC.TRDR | string |
A ID do cliente do documento |
|
endereço do cliente
|
data.SALDOC.TRDR_CUSTOMER_ADDRESS | string |
O endereço do cliente do documento |
|
T.R.No do cliente
|
data.SALDOC.TRDR_CUSTOMER_AFM | string |
Número de registro de imposto do cliente do documento |
|
código do cliente
|
data.SALDOC.TRDR_CUSTOMER_CODE | string |
O código do cliente do documento |
|
escritório de impostos do cliente
|
data.SALDOC.TRDR_CUSTOMER_IRSDATA | string |
O escritório de imposto sobre o cliente do documento |
|
profissão de cliente
|
data.SALDOC.TRDR_CUSTOMER_JOBTYPETRD | string |
A profissão do cliente do documento |
|
nome do cliente
|
data.SALDOC.TRDR_CUSTOMER_NAME | string |
O nome do cliente do documento |
|
telefone do cliente
|
data.SALDOC.TRDR_CUSTOMER_PHONE01 | string |
O número de telefone do cliente do documento |
|
data da transação
|
data.SALDOC.TRNDATE | date-time |
Data da transação do documento |
|
Valor do IVA
|
data.SALDOC.VATAMNT | string |
O valor do Imposto sobre Valor Adicionado do documento |
|
Services
|
data.SRVLINES | array of object |
Matriz de dados de serviços |
|
desconto
|
data.SRVLINES.DISC1PRC | string |
O desconto do serviço do documento |
|
número de linha
|
data.SRVLINES.LINENUM | string |
O número da linha de serviço do documento |
|
value
|
data.SRVLINES.LINEVAL | string |
O valor da linha de serviço do documento |
|
ID
|
data.SRVLINES.MTRL | string |
A ID do serviço do documento |
|
codificar
|
data.SRVLINES.MTRL_SERVICE_CODE | string |
Código do serviço do documento |
|
nome
|
data.SRVLINES.MTRL_SERVICE_NAME | string |
O nome do serviço do documento |
|
price
|
data.SRVLINES.PRICE | string |
O preço do serviço do documento |
|
quantidade
|
data.SRVLINES.QTY | string |
Quantidade de serviço do documento |
|
Análise de IVA
|
data.VATANAL | array of object |
Matriz de análise de IVA |
|
valor sujeito ao IVA
|
data.VATANAL.SUBVAL | string |
Valor total do documento sujeito à categoria de IVA |
|
ID e categoria
|
data.VATANAL.VAT | string |
ID da categoria de IVA |
|
value
|
data.VATANAL.VATVAL | string |
Valor total da categoria de IVA |
|
percent(%)
|
data.VATANAL.VAT_VAT_PERCNT | string |
Porcentagem da categoria de IVA (%) |
|
Erro
|
error | string |
Mensagem de erro se a ação não tiver êxito |
|
Código do erro
|
errorcode | integer |
Código de erro se a ação não tiver êxito |
|
Êxito
|
success | boolean |
A ação foi bem-sucedida? |
Obter email
Retorna todos os dados (ou os selecionados de LOCATEINFO) de um registro de um objeto de email
Parâmetros
| Nome | Chave | Obrigatório | Tipo | Description |
|---|---|---|---|---|
|
FORMA
|
FORM | string |
Especificar o formulário do email |
|
|
CHAVE
|
KEY | True | string |
Inserir uma ID de registro de email válida |
|
LOCATEINFO
|
LOCATEINFO | True | string |
Especificar os campos de dados desejados do email |
Retornos
| Nome | Caminho | Tipo | Description |
|---|---|---|---|
|
Legenda
|
caption | string |
Breve legenda do registro |
|
Chave Remota
|
remoteKey | string |
ID do aplicativo de terceiros |
|
operador
|
data.SOACTION.ACTOR | string |
Operador da tarefa |
|
contato do operador
|
data.SOACTION.ACTPRSN | string |
Contato do operador da tarefa |
|
status
|
data.SOACTION.ACTSTATUS | string |
O status da tarefa |
|
assunto
|
data.SOACTION.COMMENTS | string |
O assunto da tarefa |
|
data de conclusão
|
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 |
|
ordenado por
|
data.SOACTION.ORDEREDBY | string |
Orderer da tarefa |
|
ordenado pelo contato
|
data.SOACTION.ORDPRSN | string |
Contato do ordenador da tarefa |
|
priority
|
data.SOACTION.PRIORITY | string |
Prioridade da tarefa |
|
projeto
|
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ído
|
data.SOACTION.TASKCOMPLETE | string |
A tarefa foi concluída? |
|
ID do cliente
|
data.SOACTION.TRDR | string |
A ID do cliente da tarefa |
|
nome do cliente
|
data.SOACTION.TRDR_GENTRDR_NAME | string |
O nome do cliente da tarefa |
|
data de inserção
|
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 e do remetente da caixa de correio |
|
date
|
data.SOMAIL.MAILDATE | date-time |
Data do email |
|
BCC
|
data.SOMAIL.SOBCC | string |
Os destinatários da 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 anexado
|
data.XTRDOCDATA | array of object |
Matriz de dados de itens anexados |
|
linha Nº.
|
data.XTRDOCDATA.LINENUM | string |
Número de linha do item anexado |
|
nome
|
data.XTRDOCDATA.NAME | string |
Nome do arquivo do item anexado |
|
url
|
data.XTRDOCDATA.SOFNAME | string |
Endereço de URL do item anexado |
|
Erro
|
error | string |
Mensagem de erro se a ação não tiver êxito |
|
Código do erro
|
errorcode | integer |
Código de erro se a ação não tiver êxito |
|
Êxito
|
success | boolean |
A ação foi bem-sucedida? |
Obter entrada de rascunho
Retorna todos os dados (ou os selecionados de LOCATEINFO) de um registro de um objeto de entrada draft
Parâmetros
| Nome | Chave | Obrigatório | Tipo | Description |
|---|---|---|---|---|
|
FORMA
|
FORM | string |
Especificar o formulário do documento |
|
|
CHAVE
|
KEY | True | string |
Inserir uma ID de registro de documento válida |
|
LOCATEINFO
|
LOCATEINFO | True | string |
Especificar os campos de dados desejados do documento |
Retornos
| Nome | Caminho | Tipo | Description |
|---|---|---|---|
|
Legenda
|
caption | string |
Legenda breve do registro de entrada de rascunho |
|
Chave Remota
|
remoteKey | string |
ID do aplicativo de terceiros |
|
address
|
data.SODRAFT.ADDRESS | string |
O endereço da entrada de rascunho |
|
T.R.No
|
data.SODRAFT.AFM | string |
O número de registro do imposto da entrada de rascunho |
|
city
|
data.SODRAFT.CITY | string |
A cidade da entrada de rascunho |
|
codificar
|
data.SODRAFT.CODE | string |
O código da entrada de rascunho |
|
country
|
data.SODRAFT.COUNTRY | string |
O país da entrada de rascunho |
|
área
|
data.SODRAFT.DISTRICT | string |
A área da entrada de rascunho |
|
prefeitura
|
data.SODRAFT.DISTRICT1 | string |
A prefeitura da entrada de rascunho |
|
categoria
|
data.SODRAFT.DRAFTTYPE | string |
A categoria da entrada de rascunho |
|
email da empresa
|
data.SODRAFT.EMAIL | string |
O email da empresa da entrada de rascunho |
|
email de negócios
|
data.SODRAFT.EMAIL1 | string |
O email comercial da entrada de rascunho |
|
email pessoal
|
data.SODRAFT.EMAIL2 | string |
O email pessoal da entrada de rascunho |
|
Cartão de ID Não
|
data.SODRAFT.IDENTITYNUM | string |
O número do cartão de identificação da entrada de rascunho |
|
atividade
|
data.SODRAFT.JOBTYPETRD | string |
A atividade da entrada de rascunho |
|
telemóvel
|
data.SODRAFT.MOBILEPHONE | string |
O telefone celular da entrada de rascunho |
|
nome/título
|
data.SODRAFT.NAMEC | string |
Nome/título da entrada de rascunho |
|
nome próprio
|
data.SODRAFT.NAMEF | string |
O nome da entrada de rascunho |
|
surname
|
data.SODRAFT.NAMEL | string |
O sobrenome da entrada de rascunho |
|
General Com. Reg.
|
data.SODRAFT.NUMCG | string |
Registro Comercial Geral da entrada de rascunho |
|
telefone comercial
|
data.SODRAFT.PHONE1 | string |
O telefone comercial da entrada de rascunho |
|
telefone interno
|
data.SODRAFT.PHONEEXT | string |
O telefone interno da entrada de rascunho |
|
telefone pessoal
|
data.SODRAFT.PHONELOCAL | string |
O telefone pessoal da entrada de rascunho |
|
comments
|
data.SODRAFT.REMARKS | string |
Comentários da entrada de rascunho |
|
title
|
data.SODRAFT.SOTITLENAME | string |
O título da entrada de rascunho |
|
página web
|
data.SODRAFT.WEBPAGE | string |
A página da Web da entrada de rascunho |
|
zip
|
data.SODRAFT.ZIP | string |
Cep da entrada de rascunho |
|
branch
|
data.SODRAFTLNK.BRANCH | string |
O nome e a ID do branch da entrada de rascunho |
|
unidade de negócios
|
data.SODRAFTLNK.BUSUNITS | string |
O nome e a ID da unidade de negócios da entrada de rascunho |
|
departamento
|
data.SODRAFTLNK.DEPART | string |
O departamento da entrada de rascunho |
|
projeto
|
data.SODRAFTLNK.PRJC | string |
O projeto da entrada de rascunho |
|
fonte
|
data.SODRAFTLNK.PRJCLEAD | string |
O nome de origem e a ID da entrada de rascunho |
|
Erro
|
error | string |
Mensagem de erro se a ação não tiver êxito |
|
Código do erro
|
errorcode | integer |
Código de erro se a ação não tiver êxito |
|
Êxito
|
success | boolean |
A ação foi bem-sucedida? |
Obter Fornecedor
Retorna todos os dados (ou os selecionados de LOCATEINFO) de um registro de um objeto fornecedor.
Parâmetros
| Nome | Chave | Obrigatório | Tipo | Description |
|---|---|---|---|---|
|
FORMA
|
FORM | string |
Especificar o formulário do fornecedor |
|
|
CHAVE
|
KEY | True | string |
Inserir uma ID de registro de fornecedor válida |
|
LOCATEINFO
|
LOCATEINFO | True | string |
Especificar os campos de dados desejados do fornecedor |
Retornos
| Nome | Caminho | Tipo | Description |
|---|---|---|---|
|
Legenda
|
caption | string |
Legenda descritiva do registro 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 |
|
codificar
|
data.SUPBANKACC.BANK_BANK_CODE | string |
Código do banco |
|
IBAN
|
data.SUPBANKACC.IBAN | string |
Número da Conta Bancária Internacional |
|
linha Nº.
|
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 registro de imposto do fornecedor |
|
city
|
data.SUPPLIER.CITY | string |
Percentual (%) desconto do cliente |
|
código de fornecedor
|
data.SUPPLIER.CODE | string |
Código de registro do fornecedor |
|
área de localização
|
data.SUPPLIER.DISTRICT | string |
A área de localização do fornecedor |
|
correio
|
data.SUPPLIER.EMAIL | string |
O endereço de email do fornecedor |
|
FAX
|
data.SUPPLIER.FAX | string |
O número de FAX do fornecedor |
|
escritório de impostos
|
data.SUPPLIER.IRSDATA | string |
O escritório 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 primário
|
data.SUPPLIER.PHONE01 | string |
O número de telefone primário do fornecedor |
|
comments
|
data.SUPPLIER.REMARKS | string |
Comentários sobre o registro do fornecedor |
|
categoria de imposto
|
data.SUPPLIER.VATSTS | string |
A categoria de imposto do fornecedor |
|
ZIP
|
data.SUPPLIER.ZIP | string |
O cep do fornecedor |
|
Erro
|
error | string |
Mensagem de erro se a ação não tiver êxito |
|
Código do erro
|
errorcode | integer |
Código de erro se a ação não tiver êxito |
|
Êxito
|
success | boolean |
A ação foi bem-sucedida? |
Obter Item
Retorna todos os dados (ou os selecionados de LOCATEINFO) de um registro de um objeto item.
Parâmetros
| Nome | Chave | Obrigatório | Tipo | Description |
|---|---|---|---|---|
|
FORMA
|
FORM | string |
Especificar o formulário do item |
|
|
CHAVE
|
KEY | True | string |
Inserir uma ID de registro de item válida |
|
LOCATEINFO
|
LOCATEINFO | True | string |
Especificar os campos desejados do item |
Retornos
| Nome | Caminho | Tipo | Description |
|---|---|---|---|
|
Legenda
|
caption | string |
Legenda descritiva do registro do item |
|
Chave Remota
|
remoteKey | string |
ID do aplicativo de terceiros |
|
codificar
|
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 item |
|
grupo de itens
|
data.ITEM.MTRGROUP | string |
O grupo do item |
|
unidade base de medida
|
data.ITEM.MTRUNIT1 | string |
A unidade base de medida do item |
|
descrição
|
data.ITEM.NAME | string |
O nome do item |
|
preço de varejo
|
data.ITEM.PRICER | string |
O preço de varejo do item |
|
preço por atacado
|
data.ITEM.PRICEW | string |
O preço de atacado do item |
|
comments
|
data.ITEM.REMARKS | string |
Comentários do item |
|
discount (%)
|
data.ITEM.SODISCOUNT | string |
O desconto do item |
|
Grupo de IVA
|
data.ITEM.VAT | string |
O imposto sobre o valor adicionado do item |
|
Erro
|
error | string |
Mensagem de erro se a ação não tiver êxito |
|
Código do erro
|
errorcode | integer |
Código de erro se a ação não tiver êxito |
|
Êxito
|
success | boolean |
A ação foi bem-sucedida? |
Obter parâmetros do sistema
Retorna parâmetros da instalação
Retornos
| Nome | Caminho | Tipo | Description |
|---|---|---|---|
|
address
|
companyinfo.address | string |
O endereço da empresa |
|
T.R.No
|
companyinfo.afm | string |
O número de registro de imposto da empresa |
|
address
|
companyinfo.branch.address | string |
O endereço do branch da empresa |
|
área de localização
|
companyinfo.branch.district | string |
A área de localização do branch da empresa |
|
nome
|
companyinfo.branch.name | string |
O nome do branch da empresa |
|
zip
|
companyinfo.branch.zip | string |
O cep da ramificação da empresa |
|
área de localização
|
companyinfo.district | string |
A área de localização da empresa |
|
email
|
companyinfo.email | string |
O email da empresa |
|
Logotipo
|
companyinfo.image | string |
URL do logotipo da empresa |
|
escritório de impostos
|
companyinfo.irsdata | string |
O escritório fiscal da empresa |
|
nome
|
companyinfo.name | string |
O nome da empresa |
|
número telefônico
|
companyinfo.phone | string |
O número de telefone da empresa |
|
zip
|
companyinfo.zip | string |
O cep da empresa |
|
Erro
|
error | string |
Mensagem de erro se a ação não tiver êxito |
|
Código do erro
|
errorcode | integer |
Código de erro se a ação não tiver êxito |
|
Número de série
|
serialnumber | string |
O número de série da instalação |
|
Êxito
|
success | boolean |
A ação foi bem-sucedida? |
Obter Projeto
Retorna todos os dados (ou os selecionados de LOCATEINFO) de um registro de um objeto de projeto
Parâmetros
| Nome | Chave | Obrigatório | Tipo | Description |
|---|---|---|---|---|
|
FORMA
|
FORM | string |
Especificar o formulário do projeto |
|
|
CHAVE
|
KEY | True | string |
Inserir uma ID de registro de projeto válida |
|
LOCATEINFO
|
LOCATEINFO | True | string |
Especificar os campos de dados desejados do projeto |
Retornos
| Nome | Caminho | Tipo | Description |
|---|---|---|---|
|
Legenda
|
caption | string |
Breve legenda do registro do projeto |
|
status
|
data.PRJC.ACTSTATUS | string |
O status do projeto |
|
codificar
|
data.PRJC.CODE | string |
O código do projeto |
|
data de conclusão
|
data.PRJC.FINALDATE | date-time |
Data de conclusão 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 |
A ID do projeto |
|
variação
|
data.PRJC.PRJCRM | string |
A variação do projeto |
|
comments
|
data.PRJC.REMARKS | string |
Comentários do projeto |
|
Item anexado
|
data.XTRDOCDATA | array of object |
Matriz de dados de itens anexados |
|
linha Nº.
|
data.XTRDOCDATA.LINENUM | string |
Número de linha do item anexado |
|
nome
|
data.XTRDOCDATA.NAME | string |
Nome do arquivo do item anexado |
|
url
|
data.XTRDOCDATA.SOFNAME | string |
Endereço de URL do item anexado |
|
Erro
|
error | string |
Mensagem de erro se a ação não tiver êxito |
|
Código do erro
|
errorcode | integer |
Código de erro se a ação não tiver êxito |
|
Êxito
|
success | boolean |
A ação foi bem-sucedida? |
Obter Reunião
Retorna todos os dados (ou os selecionados de LOCATEINFO) de um registro de um Objeto de Reunião.
Parâmetros
| Nome | Chave | Obrigatório | Tipo | Description |
|---|---|---|---|---|
|
FORMA
|
FORM | string |
Especificar o formulário da reunião |
|
|
CHAVE
|
KEY | True | string |
Inserir uma ID de registro de reunião válida |
|
LOCATEINFO
|
LOCATEINFO | True | string |
Especificar os campos de dados desejados da reunião |
Retornos
| Nome | Caminho | Tipo | Description |
|---|---|---|---|
|
Legenda
|
caption | string |
Legenda descritiva do registro 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 |
Contato do operador da reunião |
|
status
|
data.SOACTION.ACTSTATUS | string |
O status da reunião |
|
assunto
|
data.SOACTION.COMMENTS | string |
O assunto da reunião |
|
data de conclusão
|
data.SOACTION.FINALDATE | date-time |
Data de conclusão da reunião |
|
data de início
|
data.SOACTION.FROMDATE | date-time |
Data de início da reunião |
|
ordenado por
|
data.SOACTION.ORDEREDBY | string |
Ordenador da reunião |
|
ordenado pelo contato
|
data.SOACTION.ORDPRSN | string |
Contato do ordenador da reunião |
|
priority
|
data.SOACTION.PRIORITY | string |
Prioridade da reunião |
|
projeto
|
data.SOACTION.PRJC | string |
O projeto da reunião |
|
comments
|
data.SOACTION.REMARKS | string |
Comentários sobre a reunião |
|
série
|
data.SOACTION.SERIES | string |
A série da reunião |
|
concluído
|
data.SOACTION.TASKCOMPLETE | string |
A reunião foi 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 |
|
data de inserção
|
data.SOACTION.TRNDATE | date-time |
A data em que a reunião foi criada |
|
Erro
|
error | string |
Mensagem de erro se a ação não tiver êxito |
|
Código do erro
|
errorcode | integer |
Código de erro se a ação não tiver êxito |
|
Êxito
|
success | boolean |
A ação foi bem-sucedida? |
Obter Serviços
Retorna todos os dados (ou os selecionados de LOCATEINFO) de um registro de um Objeto de Serviço.
Parâmetros
| Nome | Chave | Obrigatório | Tipo | Description |
|---|---|---|---|---|
|
FORMA
|
FORM | string |
Especificar o formulário do serviço |
|
|
CHAVE
|
KEY | True | string |
Inserir uma ID de registro de serviço válida |
|
LOCATEINFO
|
LOCATEINFO | True | string |
Especificar os campos desejados do serviço |
Retornos
| Nome | Caminho | Tipo | Description |
|---|---|---|---|
|
Legenda
|
caption | string |
Legenda descritiva do registro do serviço |
|
Chave Remota
|
remoteKey | string |
ID do aplicativo de terceiros |
|
codificar
|
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 base de medida
|
data.SERVICE.MTRUNIT1 | string |
A unidade base de medida do serviço |
|
descrição
|
data.SERVICE.NAME | string |
O nome do serviço |
|
preço de varejo
|
data.SERVICE.PRICER | string |
O preço de varejo do serviço |
|
preço por atacado
|
data.SERVICE.PRICEW | string |
O preço de atacado do serviço |
|
comments
|
data.SERVICE.REMARKS | string |
Comentários do serviço |
|
discount (%)
|
data.SERVICE.SODISCOUNT | string |
O desconto do serviço |
|
Grupo de IVA
|
data.SERVICE.VAT | string |
O imposto sobre o valor adicionado do serviço |
|
Erro
|
error | string |
Mensagem de erro se a ação não tiver êxito |
|
Código do erro
|
errorcode | integer |
Código de erro se a ação não tiver êxito |
|
Êxito
|
success | boolean |
A ação foi bem-sucedida? |
Obter Tarefa
Retorna todos os dados (ou os selecionados de LOCATEINFO) de um registro de um Objeto de Tarefa.
Parâmetros
| Nome | Chave | Obrigatório | Tipo | Description |
|---|---|---|---|---|
|
FORMA
|
FORM | string |
Especificar o formulário da tarefa |
|
|
CHAVE
|
KEY | True | string |
Inserir uma ID de registro de tarefa válida |
|
LOCATEINFO
|
LOCATEINFO | True | string |
Especificar os campos de dados desejados da tarefa |
Retornos
| Nome | 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 |
Contato do operador da tarefa |
|
status
|
data.SOACTION.ACTSTATUS | string |
O status da tarefa |
|
assunto
|
data.SOACTION.COMMENTS | string |
O assunto da tarefa |
|
data de conclusão
|
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 |
|
ordenado por
|
data.SOACTION.ORDEREDBY | string |
Orderer da tarefa |
|
ordenado pelo contato
|
data.SOACTION.ORDPRSN | string |
Contato do ordenador da tarefa |
|
priority
|
data.SOACTION.PRIORITY | string |
Prioridade da tarefa |
|
projeto
|
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ído
|
data.SOACTION.TASKCOMPLETE | string |
A tarefa foi concluída? |
|
ID do cliente
|
data.SOACTION.TRDR | string |
A ID do cliente da tarefa |
|
nome do cliente
|
data.SOACTION.TRDR_GENTRDR_NAME | string |
O nome do cliente da tarefa |
|
data de inserção
|
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 tiver êxito |
|
Código do erro
|
errorcode | integer |
Código de erro se a ação não tiver êxito |
|
Êxito
|
success | boolean |
A ação foi bem-sucedida? |
Gatilhos
| Quando um registro é criado |
Essa operação é disparada quando há registros recém-criados do objeto selecionado |
| Quando um registro é criado ou modificado |
Esta operação dispara quando há registros recém-criados ou modificados do objeto selecionado |
| Quando um registro é excluído |
Essa operação é disparada quando um registro do objeto selecionado é excluído |
| Quando um registro é modificado |
Essa operação é disparada quando há registros modificados do objeto selecionado |
Quando um registro é criado
Essa operação é disparada quando há registros recém-criados do objeto selecionado
Parâmetros
| Nome | Chave | Obrigatório | Tipo | Description |
|---|---|---|---|---|
|
Condição
|
condition | string |
Especificar uma condição |
|
|
Object
|
object | True | string |
Selecione um objeto que dispara esta operação |
Retornos
| Nome | Caminho | Tipo | Description |
|---|---|---|---|
|
ID
|
id | string |
ID do registro que foi criado. Use com a ação 'Get' correspondente para buscar o conteúdo do registro |
Quando um registro é criado ou modificado
Esta operação dispara quando há registros recém-criados ou modificados do objeto selecionado
Parâmetros
| Nome | Chave | Obrigatório | Tipo | Description |
|---|---|---|---|---|
|
Condição
|
condition | string |
Especificar uma condição |
|
|
Object
|
object | True | string |
Selecione um objeto que dispara esta operação |
Retornos
| Nome | 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 registro é excluído
Essa operação é disparada quando um registro do objeto selecionado é excluído
Parâmetros
| Nome | Chave | Obrigatório | Tipo | Description |
|---|---|---|---|---|
|
Condição
|
condition | string |
Especificar uma condição |
|
|
Object
|
object | True | string |
Selecione um objeto que dispara esta operação |
Retornos
| Nome | Caminho | Tipo | Description |
|---|---|---|---|
|
ID
|
id | string |
ID do registro que foi excluído |
Quando um registro é modificado
Essa operação é disparada quando há registros modificados do objeto selecionado
Parâmetros
| Nome | Chave | Obrigatório | Tipo | Description |
|---|---|---|---|---|
|
Condição
|
condition | string |
Especificar uma condição |
|
|
Object
|
object | True | string |
Selecione um objeto que dispara esta operação |
Retornos
| Nome | Caminho | Tipo | Description |
|---|---|---|---|
|
ID
|
id | string |
ID do registro que foi modificado. Use com a ação 'Get' correspondente para buscar o conteúdo do registro |
Definições
setData200response
| Nome | Caminho | Tipo | Description |
|---|---|---|---|
|
Erro
|
error | string |
Mensagem de erro se a ação não tiver êxito |
|
Código do erro
|
errorcode | integer |
Código de erro se a ação não tiver êxito |
|
ID
|
id | string |
ID do registro do documento que foi criado ou modificado |
|
Êxito
|
success | boolean |
A ação foi bem-sucedida? |