Lexoffice (Editora Independente) (Pré-visualização)

A API da Lexware fornece acesso programático às funcionalidades essenciais do negócio da empresa, como artigos, contactos, faturas, encomendas e gestão de ficheiros. Este conector Independent Publisher permite a integração segura com a API REST da Lexware, permitindo aos utilizadores criar e recuperar dados empresariais, automatizar processos e ligar recursos Lexware a aplicações Power Platform. O conector utiliza o OAuth 2.0 Authorization Code Flow para autenticação segura e diretrizes da API.

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

Serviço	Class	Regiões
Estúdio Copiloto	Premium	Todas as regiões do Power Automatic , exceto as seguintes: - Governo dos EUA (CCG) - Governo dos EUA (GCC High) - China Cloud operado pela 21Vianet - Departamento de Defesa dos EUA (DoD)
Aplicações Lógicas	Standard	Todas as regiões do Logic Apps , exceto as seguintes: - Regiões do Azure Government - Regiões do Azure China - Departamento de Defesa dos EUA (DoD)
Aplicações Power	Premium	Todas as regiões do Power Apps , exceto as seguintes: - Governo dos EUA (CCG) - Governo dos EUA (GCC High) - China Cloud operado pela 21Vianet - Departamento de Defesa dos EUA (DoD)
Power Automate	Premium	Todas as regiões do Power Automatic , exceto as seguintes: - Governo dos EUA (CCG) - Governo dos EUA (GCC High) - China Cloud operado pela 21Vianet - Departamento de Defesa dos EUA (DoD)

Contato
Nome	Suporte ao Investigador LowCode
URL	https://lowcode-investigator.com/
Email	kontakt@lowcodeinvestigator.com

Metadados do conector
Editora	LowCodeInvestigator
Sítio Web	https://office.lexware.de/
Política de privacidade	https://office.lexware.de/datenschutz/
Categorias	Gestão Empresarial; Finanças

Lexware API Connector (Editor Independente)

A API Lexware é uma interface RESTful que permite aos programadores integrar funções empresariais Lexware, como contactos, faturas, artigos e ficheiros, nas suas próprias aplicações. Este conector permite a interação direta com estes recursos através de pedidos de API seguros e autenticados.

Editora: Independent Publisher

Pré-requisitos

Uma conta Lexware registada e uma licença adequada
Uma chave API válida (token de acesso) obtida através do Portal de Desenvolvedores Lexware
O Fluxo de Código de Autorização OAuth 2.0 é necessário para autenticação

Operações suportadas

Este conector suporta os seguintes endpoints da API Lexware:

Artigos: Criar, recuperar, atualizar, eliminar e filtrar artigos
Contactos: Gerir dados de clientes e fornecedores
Faturas: Criar e recuperar dados de faturas, incluindo a visualização de PDFs
Notas de Crédito, Notas de Entrega, Encomendas, Orçamentos e Vouchers
Países, Condições de Pagamento, Layouts de Impressão e Perfis
Subscrições e Ficheiros de Eventos
Lista completa documentada em: Lexware API Docs

Obtenção de credenciais

Para chamar a API da Lexware precisas de uma chave API:

Inicie sessão na sua conta Lexware Office.
Navegar até Extensões → Weitere Apps → API Pública ou abrir
Portal de Desenvolvedores Lexware diretamente.
Crie uma nova chave de API com as permissões desejadas.
Copie a chave API gerada. Este valor será usado como accessToken no conector.

Gateway de API

Por favor, utilize o novo gateway API da Lexware:

https://api.lexware.io

Limites de Taxa

Máximo 2 pedidos por segundo
Pedidos que excedam este limite recebem HTTP 429 Too Many Requests
Recomendado: Usar algoritmo de bucket de token ou backoff exponencial

Authentication

A API da Lexware utiliza o Fluxo de Código de Autorização OAuth 2.0. Inclua o token no Authorization: Bearer {accessToken} cabeçalho de cada pedido.

Exemplo de Utilização

Escrever um artigo:

curl https://api.lexware.io/v1/articles \
  -X POST \
  -H "Authorization: Bearer {accessToken}" \
  -H "Content-Type: application/json" \
  -d '{
    "title": "Lexware Buchhaltung Premium 2024",
    "type": "PRODUCT",
    "unitName": "Download-Code",
    "articleNumber": "LXW-BUHA-2024-001",
    "price": {
      "netPrice": 61.90,
      "leadingPrice": "NET",
      "taxRate": 19
    }
  }'

Problemas conhecidos e limitações

Máximo 2 pedidos por segundo
Alguns endpoints requerem permissões ou funções adicionais

Documentação da API

A referência completa da API está disponível em:
https://developers.lexware.io/docs/

A criar uma ligação

O conector suporta os seguintes tipos de autenticação:


Predefinição	Parâmetros para criar conexão.	Todas as regiões	Não compartilhável

Padrão

Aplicável: Todas as regiões

Parâmetros para criar conexão.

Esta conexão não é compartilhável. Se o aplicativo avançado for compartilhado com outro usuário, outro usuário será solicitado a criar uma nova conexão explicitamente.

Nome	Tipo	Description	Obrigatório
Chave de API	securestring	A chave de API para esta api	Verdade

Limites de Limitação

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

Ações

Apaga um Event-Subscription	Delete Trigger WebHook
Apresentar um Documento de Citação (PDF)	Para descarregar o ficheiro pdf de um documento de citação, precisa do seu documentFileId. Este id é normalmente devolvido pelo recurso de citação. No entanto, as novas citações criadas no estado aberto através da API têm de ativar separadamente a renderização do ficheiro do documento pdf. Isto pode ser feito com este endpoint.
Apresentar um Documento de Fatura (PDF)	Para descarregar o ficheiro pdf de um documento de fatura, precisa do seu documentFileId. Este ID é normalmente devolvido pela fonte de faturação. No entanto, faturas recém-criadas em estado aberto via API têm de ativar separadamente a renderização do ficheiro do documento PDF. Isto pode ser feito com este endpoint.
Apresentar um Documento de Nota de Crédito (PDF)	Para descarregar o ficheiro pdf de um documento de nota de crédito, precisa do seu documentFileId. Este ID é normalmente devolvido pela fonte da nota de crédito. No entanto, as notas de crédito recém-criadas em estado aberto via API têm de ativar separadamente a renderização do ficheiro PDF. Isto pode ser feito com este endpoint.
Apresentar um Documento de Nota de Entrega (PDF)	Este endpoint oferece acesso de leitura e escrita às notas de entrega e também a possibilidade de apresentar o documento em PDF para o descarregar. As notas de entrega são sempre criadas em modo de rascunho e não precisam de ser finalizadas.
Atualizar um artigo	Atualize um artigo existente com id {id} com os dados fornecidos no payload como JSON. Devolve um resultado de ação em caso de sucesso.
Atualizar um contato	Atualizar um contacto
Carregar um ficheiro	Use este endpoint para carregar ficheiros, por exemplo, vouchers ou faturas.
Carregar um ficheiro para um Voucher	Carregue e atribua ficheiros (pdf ou imagem) ao voucher identificado por {id}.
Criar um artigo	O conteúdo do artigo é esperado no corpo do pedido como uma candidatura/json.
Criar um contacto	Criar um novo contacto
Criar um mergulho	O dunning criado não será mostrado na lista principal de vouchers no lexoffice, mas estará anexado a uma fatura e será visível lá. Para fornecer aos seus clientes acesso ao dunning criado, por favor utilize a nossa função de deeplink.
Criar uma Cotação	As cotações transmitidas via API são criadas em modo rascunho por defeito. Para criar uma cotação finalizada com estado aberto, o parâmetro opcional de consulta finalizar deve ser definido. O estado de uma citação não pode ser alterado através da API.
Criar uma Fatura	As faturas transmitidas via API são criadas em modo de rascunho, por defeito. Para criar uma fatura finalizada com estado aberto, é necessário definir o parâmetro opcional de consulta, finalizar. O estado de uma fatura não pode ser alterado através da API.
Criar uma Nota de Entrega	A nota de entrega criada será mostrada na lista principal de vouchers no lexoffice. As notas de entrega transmitidas via API são criadas apenas em modo rascunho.
Crie um Voucher	Criar vouchers (restritos a vouchers de venda)
Crie uma Confirmação de Encomenda	Este endpoint oferece acesso de leitura e escrita para confirmações de encomendas e também a possibilidade de apresentar o documento em PDF para o descarregar. As confirmações de encomendas são sempre criadas em modo de rascunho e não precisam de ser finalizadas.
Crie uma Nota de Crédito	As notas de crédito transmitidas via API são criadas em modo de rascunho por defeito. Para criar uma nota de crédito finalizada com estado aberto, o parâmetro opcional de consulta finalizar tem de ser definido. O estado de uma nota de crédito não pode ser alterado através da API
Descarregar um ficheiro	Use este endpoint para descarregar ficheiros.
Eliminar um artigo	Apaga o artigo com valor id {id}. Devolve 204 em caso de sucesso, ou 404 se o id não existir.
Emitir um Documento de Confirmação de Ordem (PDF)	Para descarregar o ficheiro pdf de um documento de confirmação de encomenda, precisa do seu documentFileId. Este id é normalmente devolvido pelo recurso de confirmação de encomendas. No entanto, as confirmações de encomendas recém-criadas através da API têm de ativar separadamente a renderização do ficheiro do documento pdf. Isto pode ser feito com este endpoint.
Filtragem de Artigos	Devolve os artigos que cumprem os critérios dados pelos filtros filter_1 para filter_n usando um mecanismo de paginação. Se forem dados mais do que um filtro, o conector lógico é AND. Filtros que não estão definidos são ignorados. Para verificar o tamanho máximo da página para este endpoint, veja Paginação de Recursos.
Recuperar e Filtrar Lista de Vouchers	Obtenha vales de lista de vales (contabilidade) (por exemplo, faturas de vendas, notas de crédito de vendas), faturas (incluindo faturas de entrada inicial), notas de crédito, confirmações de encomendas, orçamentos e notas de entrega.
Recuperar Informação de Pagamento	O endpoint de pagamentos fornece acesso de leitura ao estado de pagamento de vouchers (de contabilidade ou vendas), incluindo faturas e notas de crédito.
Recuperar Informação do Perfil	O exemplo seguinte mostra como obter a informação básica do seu perfil. É necessário substituir o marcador {accessToken} antes de enviar o pedido.
Recuperar Lista de Condições de Pagamento	O exemplo seguinte mostra como recuperar a lista de condições de pagamento atualmente configuradas. É necessário substituir o marcador {accessToken} antes de enviar o pedido.
Recuperar Lista de Países	Lista de países conhecidos pelo lexoffice.
Recuperar todas as subscrições de eventos	Recuperar todas as subscrições de eventos
Recuperar todos os Contactos	Recuperar todos os Contactos
Recuperar todos os Modelos Recorrentes	Recupere uma coleção de modelos recorrentes. O resultado devolve apenas parte dos dados mais relevantes, que são o contacto referenciado (apenas ID e nome), o preço total, as condições de pagamento e as definições completas dos modelos recorrentes. A nomeação dos objetos e propriedades é a mesma, no entanto.
Recuperar um artigo	Devolve o artigo com o valor id {id}.
Recuperar um Contacto	Recuperar um contacto por id
Recuperar um mergulho	Devolve o dunning com o valor de id {id}.
Recuperar um Modelo Recorrente	Devolve o modelo recorrente com o valor id {id}.
Recuperar uma Citação	Devolve a citação com valor id {id}. Apresentar um Documento de Citação (PDF)
Recuperar uma Confirmação de Encomenda	Devolve a confirmação da encomenda com o valor id {id}.
Recuperar uma Fatura	Devolve a fatura com o valor de identificação {id}.
Recuperar uma Lista de Categorias de Publicação	Este endpoint fornece acesso de leitura à lista de categorias de publicação para as receitas ou despesas (de contabilidade) que são suportadas no lexoffice.
Recuperar uma Nota de Crédito	Este endpoint oferece acesso de leitura e escrita às notas de crédito e também a possibilidade de apresentar o documento em PDF para o descarregar. As notas de crédito podem ser criadas em rascunho ou finalizadas em modo aberto.
Recuperar uma Nota de Entrega	Devolve a nota de entrega com valor id {id}.
Recupere um Voucher	Listar os vales de venda (por exemplo, faturas, notas de crédito)
Recupere uma Fatura de Entrada	Devolve a fatura de entrada com valor de identificação {id}.
Recupere uma Subscrição de Evento	Recupere uma Subscrição de Evento
Renderizar um documento de dunning (PDF)	Para descarregar o ficheiro pdf de um documento de dunning, precisa do seu documentFileId. Este id é normalmente devolvido pelo recurso de dunning. No entanto, os dunnings recém-criados através da API têm de ativar separadamente a renderização do ficheiro do documento PDF. Isto pode ser feito com este endpoint.
Voucher de Atualização	Atualizar um voucher

Apaga um Event-Subscription

ID da Operação:: DeleteEventSubscription

Delete Trigger WebHook

Parâmetros

Name	Chave	Necessário	Tipo	Description
ID da Subscrição	subscriptionId	True	string	Especifique o ID da subscrição.

Apresentar um Documento de Citação (PDF)

ID da Operação:: RenderQuotationDocument

Para descarregar o ficheiro pdf de um documento de citação, precisa do seu documentFileId. Este id é normalmente devolvido pelo recurso de citação. No entanto, as novas citações criadas no estado aberto através da API têm de ativar separadamente a renderização do ficheiro do documento pdf. Isto pode ser feito com este endpoint.

Parâmetros

Name	Chave	Necessário	Tipo	Description
Id	id	True	string	Especifique o ID.

Devoluções

Name	Caminho	Tipo	Description
documentFileId	documentFileId	uuid

Apresentar um Documento de Fatura (PDF)

ID da Operação:: RenderInvoiceDocument

Para descarregar o ficheiro pdf de um documento de fatura, precisa do seu documentFileId. Este ID é normalmente devolvido pela fonte de faturação. No entanto, faturas recém-criadas em estado aberto via API têm de ativar separadamente a renderização do ficheiro do documento PDF. Isto pode ser feito com este endpoint.

Parâmetros

Name	Chave	Necessário	Tipo	Description
Id	id	True	string	Especifique o ID.

Devoluções

Name	Caminho	Tipo	Description
documentFileId	documentFileId	uuid

Apresentar um Documento de Nota de Crédito (PDF)

ID da Operação:: RenderCreditNoteDocument

Para descarregar o ficheiro pdf de um documento de nota de crédito, precisa do seu documentFileId. Este ID é normalmente devolvido pela fonte da nota de crédito. No entanto, as notas de crédito recém-criadas em estado aberto via API têm de ativar separadamente a renderização do ficheiro PDF. Isto pode ser feito com este endpoint.

Parâmetros

Name	Chave	Necessário	Tipo	Description
Id	id	True	string	Especifique o ID.

Devoluções

Name	Caminho	Tipo	Description
documentFileId	documentFileId	uuid

Apresentar um Documento de Nota de Entrega (PDF)

ID da Operação:: RenderDeliveryNoteDocument

Este endpoint oferece acesso de leitura e escrita às notas de entrega e também a possibilidade de apresentar o documento em PDF para o descarregar. As notas de entrega são sempre criadas em modo de rascunho e não precisam de ser finalizadas.

Parâmetros

Name	Chave	Necessário	Tipo	Description
Entrega Notada	DeliveryNoteid	True	string	Especifique a nota de entrega.

Devoluções

Name	Caminho	Tipo
city	address.city	string
Código do país	address.countryCode	string
nome	address.name	string
rua	address.street	string
Suplemento	address.supplement	string
ZIP	address.zip	string
arquivado	archived	boolean
createdDate (Data de criação)	createdDate	date-time
Termos de entrega	deliveryTerms	string
id	id	uuid
Introdução	introduction	string
linguagem	language	string
lineItems	lineItems	array of object
nome	lineItems.name	string
quantidade	lineItems.quantity	number
tipo	lineItems.type	string
Nome da unidade	lineItems.unitName	string
moeda	lineItems.unitPrice.currency	string
Montante bruto	lineItems.unitPrice.grossAmount	float
montante líquido	lineItems.unitPrice.netAmount	float
taxRatePercentagem	lineItems.unitPrice.taxRatePercentage	number
organizationId	organizationId	uuid
comentário	remark	string
Tipo de Imposto	taxConditions.taxType	string
title	title	string
atualizadoData de atualização	updatedDate	date-time
versão	version	integer
voucherData	voucherDate	date-time
voucherNumber	voucherNumber	string
Estado do voucher	voucherStatus	string

Atualizar um artigo

ID da Operação:: UpdateAnArticle

Atualize um artigo existente com id {id} com os dados fornecidos no payload como JSON. Devolve um resultado de ação em caso de sucesso.

Parâmetros

Name	Chave	Necessário	Tipo	Description
Id	id	True	string	Especifique o ID.
articleNúmero	articleNumber		string	articleNúmero
GTIN	gtin		string	GTIN
Observação	note		string	Observação
preço bruto	grossPrice	True	float	preço bruto
líder Price	leadingPrice	True	string	líder Price
netPreço	netPrice	True	float	netPreço
taxRate	taxRate		float	taxRate
title	title		string	title
tipo	type	True	string	tipo
Nome da unidade	unitName	True	string	Nome da unidade
versão	version	True	integer	versão

Devoluções

Body: Response_articles_id_get

Atualizar um contato

ID da Operação:: UpdateContact

Atualizar um contacto

Parâmetros

Name	Chave	Necessário	Tipo	Description
Id	id	True	string	Especifique o ID.

Devoluções

Body: Response_contacts_id_put

Carregar um ficheiro

ID da Operação:: UploadFile_Lexoffice

Use este endpoint para carregar ficheiros, por exemplo, vouchers ou faturas.

Parâmetros

Name	Chave	Necessário	Tipo	Description
Ficheiro	file	True	file	O ficheiro a carregar.
Tipo	type	True	string	Descrição do conteúdo do ficheiro.

Devoluções

Body: Response_files_post

Carregar um ficheiro para um Voucher

ID da Operação:: UploadFileVoucher_Lexoffice

Carregue e atribua ficheiros (pdf ou imagem) ao voucher identificado por {id}.

Parâmetros

Name	Chave	Necessário	Tipo	Description
Id	id	True	string	Especifique o ID.
Ficheiro	file	True	file	O ficheiro a carregar.

Criar um artigo

ID da Operação:: CreateArticle

O conteúdo do artigo é esperado no corpo do pedido como uma candidatura/json.

Parâmetros

Name	Chave	Tipo	Description
articleNúmero	articleNumber	string	articleNúmero
preço bruto	grossPrice	float	preço bruto
líder Price	leadingPrice	string	líder Price
netPreço	netPrice	float	netPreço
taxRate	taxRate	float	taxRate
title	title	string	title
tipo	type	string	tipo
Nome da unidade	unitName	string	Nome da unidade

Devoluções

Body: Response_articles_post

Criar um contacto

ID da Operação:: CreateContact

Criar um novo contacto

Devoluções

Body: Response_contacts_post

Criar um mergulho

ID da Operação:: CreateDunning

O dunning criado não será mostrado na lista principal de vouchers no lexoffice, mas estará anexado a uma fatura e será visível lá. Para fornecer aos seus clientes acesso ao dunning criado, por favor utilize a nossa função de deeplink.

Parâmetros

Name	Chave	Necessário	Tipo	Description
ID do Voucher de Venda Anterior	precedingSalesVoucherId		string	Especifique o ID do voucher de venda anterior.

Devoluções

Body: Response_dunnings_post

Criar uma Cotação

ID da Operação:: CreateQuotation

As cotações transmitidas via API são criadas em modo rascunho por defeito. Para criar uma cotação finalizada com estado aberto, o parâmetro opcional de consulta finalizar deve ser definido. O estado de uma citação não pode ser alterado através da API.

Parâmetros

Name	Chave	Necessário	Tipo	Description
Finalizar	finalize	True	boolean	Especifique a finalização.

Devoluções

Body: Response_quotations_post

Criar uma Fatura

ID da Operação:: CreateInvoice

As faturas transmitidas via API são criadas em modo de rascunho, por defeito. Para criar uma fatura finalizada com estado aberto, é necessário definir o parâmetro opcional de consulta, finalizar. O estado de uma fatura não pode ser alterado através da API.

Parâmetros

Name	Chave	Necessário	Tipo	Description
ID do Voucher de Venda Anterior	precedingSalesVoucherId		string	Especifique o ID do voucher de venda anterior.
Finalizar	finalize	True	boolean	Especifique a finalização.

Devoluções

Body: Response_invoices_post

Criar uma Nota de Entrega

ID da Operação:: CreateDeliveryNote

A nota de entrega criada será mostrada na lista principal de vouchers no lexoffice. As notas de entrega transmitidas via API são criadas apenas em modo rascunho.

Parâmetros

Name	Chave	Necessário	Tipo	Description
ID do Voucher de Venda Anterior	precedingSalesVoucherId		string	Especifique o ID do voucher de venda anterior.

Devoluções

Body: Response_delivery-notes_post

Crie um Voucher

ID da Operação:: CreateVoucher

Criar vouchers (restritos a vouchers de venda)

Parâmetros

Name	Chave	Necessário	Tipo
contactId	contactId		string
data de vencimento	dueDate		date
comentário	remark		string
data de envio	shippingDate		date
Tipo de Imposto	taxType	True	string
totalQuantumBrutoValor	totalGrossAmount		float
totalTaxAmount	totalTaxAmount		float
tipo	type	True	string
useCollectiveContact	useCollectiveContact		boolean
voucherData	voucherDate		date
Montante	amount		float
categoryId	categoryId		string
taxMontante	taxAmount		float
taxTaxPercentagem	taxRatePercent		integer
voucherNumber	voucherNumber		string
Estado do voucher	voucherStatus		string

Devoluções

Body: Response_vouchers_post

Crie uma Confirmação de Encomenda

ID da Operação:: CreateOrderConfirmation

Este endpoint oferece acesso de leitura e escrita para confirmações de encomendas e também a possibilidade de apresentar o documento em PDF para o descarregar. As confirmações de encomendas são sempre criadas em modo de rascunho e não precisam de ser finalizadas.

Parâmetros

Name	Chave	Necessário	Tipo	Description
ID do Voucher de Venda Anterior	precedingSalesVoucherId		string	Especifique o ID do voucher de venda anterior.

Devoluções

Body: Response_order-confirmations_post

Crie uma Nota de Crédito

ID da Operação:: CreateCreditNote

As notas de crédito transmitidas via API são criadas em modo de rascunho por defeito. Para criar uma nota de crédito finalizada com estado aberto, o parâmetro opcional de consulta finalizar tem de ser definido. O estado de uma nota de crédito não pode ser alterado através da API

Parâmetros

Name	Chave	Necessário	Tipo	Description
ID do Voucher de Venda Anterior	precedingSalesVoucherId		string	Especifique o ID do voucher de venda anterior.
Finalizar	finalize	True	boolean	Especifique a finalização.

Devoluções

Body: Response_credit-notes_post

Descarregar um ficheiro

ID da Operação:: DownloadFile_Lexoffice

Use este endpoint para descarregar ficheiros.

Parâmetros

Name	Chave	Necessário	Tipo	Description
ID do arquivo	fileId	True	string	Especifique o ID do ficheiro.
Aceitar	Accept		string	Especifique a aceitação.

Devoluções

response: file

Eliminar um artigo

ID da Operação:: DeleteAnArticle

Apaga o artigo com valor id {id}. Devolve 204 em caso de sucesso, ou 404 se o id não existir.

Parâmetros

Name	Chave	Necessário	Tipo	Description
Id	id	True	string	Especifique o ID.

Emitir um Documento de Confirmação de Ordem (PDF)

ID da Operação:: RenderOrderConfirmationDocument

Para descarregar o ficheiro pdf de um documento de confirmação de encomenda, precisa do seu documentFileId. Este id é normalmente devolvido pelo recurso de confirmação de encomendas. No entanto, as confirmações de encomendas recém-criadas através da API têm de ativar separadamente a renderização do ficheiro do documento pdf. Isto pode ser feito com este endpoint.

Parâmetros

Name	Chave	Necessário	Tipo	Description
Id	id	True	string	Especifique o ID.

Devoluções

Name	Caminho	Tipo	Description
documentFileId	documentFileId	uuid

Filtragem de Artigos

ID da Operação:: FilteringArticles

Devolve os artigos que cumprem os critérios dados pelos filtros filter_1 para filter_n usando um mecanismo de paginação. Se forem dados mais do que um filtro, o conector lógico é AND. Filtros que não estão definidos são ignorados. Para verificar o tamanho máximo da página para este endpoint, veja Paginação de Recursos.

Parâmetros

Name	Chave	Tipo	Description
Número do artigo	articleNumber	string	Especifique o número do artigo.
Gtin	gtin	string	Especifique o gtin.
Tipo	type	string	Especifique o tipo.
Página	page	integer	Especifique a página.
Tamanho	size	integer	Especifique o tamanho.
Ordenar	sort	string	Especifique o tipo.

Devoluções

Body: Response_articles_get

Recuperar e Filtrar Lista de Vouchers

ID da Operação:: RetrieveAndFilterVoucherlist

Obtenha vales de lista de vales (contabilidade) (por exemplo, faturas de vendas, notas de crédito de vendas), faturas (incluindo faturas de entrada inicial), notas de crédito, confirmações de encomendas, orçamentos e notas de entrega.

Parâmetros

Name	Chave	Necessário	Tipo	Description
Tipo de Valão	voucherType	True	string	Especifique o tipo de voucher.
Estado do Voucher	voucherStatus	True	string	Especifique o estado do voucher.
Arquivado	archived		boolean	Especifique o arquivo arquivado.
ID de contato	contactId		string	Especifique o ID de contacto.
Data do Voucher de	voucherDateFrom		string	Especifique a data do voucher.
Data do Voucher Para	voucherDateTo		string	Especifique a data do voucher.
Data de criação a partir de	createdDateFrom		string	Especifique a data de criação.
Data de criação para	createdDateTo		string	Especifique a data de criação.
Data de atualização de	updatedDateFrom		string	Especifique a data de atualização de.
Data de atualização para	updatedDateTo		string	Especifique a data de atualização para.
Número do Voucher	voucherNumber		string	Especifique o número do voucher.
Página	page		integer	Especifique a página.
Tamanho	size		integer	Especifique o tamanho.
Ordenar	sort		string	Especifique o tipo.

Devoluções

Body: Response_voucherlist_get

Recuperar Informação de Pagamento

ID da Operação:: RetrievePaymentInformation

O endpoint de pagamentos fornece acesso de leitura ao estado de pagamento de vouchers (de contabilidade ou vendas), incluindo faturas e notas de crédito.

Parâmetros

Name	Chave	Necessário	Tipo	Description
Voucher Id	voucherId	True	string	Especifique o ID do voucher.

Devoluções

Name	Caminho	Tipo
moeda	currency	string
openAmount	openAmount	string
Itens de pagamento	paymentItems	array of object
Montante	paymentItems.amount	float
moeda	paymentItems.currency	string
pagamentoItemType	paymentItems.paymentItemType	string
Data de publicação	paymentItems.postingDate	date-time
estado do pagamento	paymentStatus	string
Estado do voucher	voucherStatus	string
voucherType	voucherType	string

Recuperar Informação do Perfil

ID da Operação:: RetrieveProfileInformation

O exemplo seguinte mostra como obter a informação básica do seu perfil. É necessário substituir o marcador {accessToken} antes de enviar o pedido.

Devoluções

Body: Response_profile_get

Recuperar Lista de Condições de Pagamento

ID da Operação:: RetrieveListOfPaymentConditions

O exemplo seguinte mostra como recuperar a lista de condições de pagamento atualmente configuradas. É necessário substituir o marcador {accessToken} antes de enviar o pedido.

Devoluções

response: array of Response_payment-conditions_get_items

Recuperar Lista de Países

ID da Operação:: RetrieveListCountries

Lista de países conhecidos pelo lexoffice.

Devoluções

response: array of Response_countries_get_default

Recuperar todas as subscrições de eventos

ID da Operação:: RetrieveAllEventSubscriptions

Recuperar todas as subscrições de eventos

Devoluções

Body: Response_event-subscriptions_get

Recuperar todos os Contactos

ID da Operação:: RetrieveAllContacts

Recuperar todos os Contactos

Parâmetros

Name	Chave	Tipo	Description
Número	number	integer	Especifique o número.
Email	email	string	Especifique o email.
Nome	name	string	Especifique o nome.
Fornecedor	vendor	boolean	Especifique o fornecedor.
Cliente	customer	boolean	Especifique o cliente.
Página	page	integer	Especifique a página.
Tamanho	size	integer	Especifique o tamanho.
Ordenar	sort	string	Especifique o tipo.

Devoluções

Body: Response_contacts_get

Recuperar todos os Modelos Recorrentes

ID da Operação:: RetrieveAllRecurringTemplates

Recupere uma coleção de modelos recorrentes. O resultado devolve apenas parte dos dados mais relevantes, que são o contacto referenciado (apenas ID e nome), o preço total, as condições de pagamento e as definições completas dos modelos recorrentes. A nomeação dos objetos e propriedades é a mesma, no entanto.

Parâmetros

Name	Chave	Tipo	Description
Página	page	integer	Especifique a página.
Tamanho	size	integer	Especifique o tamanho.
Ordenar	sort	string	Especifique o tipo.

Devoluções

Body: Response_recurring-templates_get

Recuperar um artigo

ID da Operação:: RetrieveAnArticle

Devolve o artigo com o valor id {id}.

Parâmetros

Name	Chave	Necessário	Tipo	Description
Id	id	True	string	Especifique o ID.

Devoluções

Name	Caminho	Tipo
articleNúmero	articleNumber	string
GTIN	gtin	string
id	id	string
Observação	note	string
preço bruto	price.grossPrice	float
líder Price	price.leadingPrice	string
netPreço	price.netPrice	float
taxRate	price.taxRate	float
title	title	string
tipo	type	string
Nome da unidade	unitName	string
versão	version	integer

Recuperar um Contacto

ID da Operação:: RetrieveContact

Recuperar um contacto por id

Parâmetros

Name	Chave	Necessário	Tipo	Description
Id	id	True	string	Especifique o ID.

Devoluções

Name	Caminho	Tipo
arquivado	archived	boolean
id	id	string
organizationId	organizationId	string
primeiroNome	person.firstName	string
sobrenome	person.lastName	string
saudação	person.salutation	string
número	roles.customer.number	integer
versão	version	integer

Recuperar um mergulho

ID da Operação:: RetrieveDunning

Devolve o dunning com o valor de id {id}.

Parâmetros

Name	Chave	Necessário	Tipo	Description
Dunningsid	dunningsid	True	string	Especifique o dunningsid.

Devoluções

Name	Caminho	Tipo
city	address.city	string
Código do país	address.countryCode	string
nome	address.name	string
rua	address.street	string
Suplemento	address.supplement	string
ZIP	address.zip	string
arquivado	archived	boolean
createdDate (Data de criação)	createdDate	date-time
id	id	uuid
Introdução	introduction	string
linguagem	language	string
lineItems	lineItems	array of object
discountPercentage	lineItems.discountPercentage	number
LineItemAmount	lineItems.lineItemAmount	number
nome	lineItems.name	string
quantidade	lineItems.quantity	number
tipo	lineItems.type	string
Nome da unidade	lineItems.unitName	string
moeda	lineItems.unitPrice.currency	string
Montante bruto	lineItems.unitPrice.grossAmount	number
montante líquido	lineItems.unitPrice.netAmount	number
taxRatePercentagem	lineItems.unitPrice.taxRatePercentage	number
organizationId	organizationId	uuid
Vouchers relacionados	relatedVouchers	array of object
id	relatedVouchers.id	uuid
voucherNumber	relatedVouchers.voucherNumber	string
voucherType	relatedVouchers.voucherType	string
comentário	remark	string
data de envio	shippingConditions.shippingDate	date-time
ShipType	shippingConditions.shippingType	string
ImpostosValores	taxAmounts	array of object
montante líquido	taxAmounts.netAmount	number
taxMontante	taxAmounts.taxAmount	number
taxRatePercentagem	taxAmounts.taxRatePercentage	number
Tipo de Imposto	taxConditions.taxType	string
title	title	string
moeda	totalPrice.currency	string
totalQuantumBrutoValor	totalPrice.totalGrossAmount	number
totalNetAmount	totalPrice.totalNetAmount	number
totalTaxAmount	totalPrice.totalTaxAmount	number
atualizadoData de atualização	updatedDate	date-time
versão	version	integer
voucherData	voucherDate	date-time
Estado do voucher	voucherStatus	string

Recuperar um Modelo Recorrente

ID da Operação:: RetrieveRecurringTemplate

Devolve o modelo recorrente com o valor id {id}.

Parâmetros

Name	Chave	Necessário	Tipo	Description
Id	id	True	string	Especifique o ID.

Devoluções

Name	Caminho	Tipo
city	address.city	string
contactId	address.contactId	uuid
Código do país	address.countryCode	string
nome	address.name	string
rua	address.street	string
ZIP	address.zip	string
arquivado	archived	boolean
createdDate (Data de criação)	createdDate	date-time
id	id	uuid
Introdução	introduction	string
linguagem	language	string
lineItems	lineItems	array of object
discountPercentage	lineItems.discountPercentage	number
LineItemAmount	lineItems.lineItemAmount	number
nome	lineItems.name	string
quantidade	lineItems.quantity	number
tipo	lineItems.type	string
Nome da unidade	lineItems.unitName	string
moeda	lineItems.unitPrice.currency	string
Montante bruto	lineItems.unitPrice.grossAmount	number
montante líquido	lineItems.unitPrice.netAmount	number
taxRatePercentagem	lineItems.unitPrice.taxRatePercentage	number
organizationId	organizationId	uuid
PagamentoPrazoDuração	paymentConditions.paymentTermDuration	integer
pagamentoTermoRótulo	paymentConditions.paymentTermLabel	string
TermoModelo de RótuloPagamento	paymentConditions.paymentTermLabelTemplate	string
recorrenteTemplateDefinições	recurringTemplateSettings	object
comentário	remark	string
ImpostosValores	taxAmounts	array of object
montante líquido	taxAmounts.netAmount	number
taxMontante	taxAmounts.taxAmount	number
taxRatePercentagem	taxAmounts.taxRatePercentage	number
Tipo de Imposto	taxConditions.taxType	string
title	title	string
moeda	totalPrice.currency	string
totalQuantumBrutoValor	totalPrice.totalGrossAmount	number
totalNetAmount	totalPrice.totalNetAmount	number
totalTaxAmount	totalPrice.totalTaxAmount	number
atualizadoData de atualização	updatedDate	date-time
versão	version	integer

Recuperar uma Citação

ID da Operação:: RetrieveQuotation

Devolve a citação com valor id {id}. Apresentar um Documento de Citação (PDF)

Parâmetros

Name	Chave	Necessário	Tipo	Description
Id	id	True	string	Especifique o ID.

Devoluções

Name	Caminho	Tipo
city	address.city	string
contactId	address.contactId	uuid
Código do país	address.countryCode	string
nome	address.name	string
rua	address.street	string
ZIP	address.zip	string
arquivado	archived	boolean
createdDate (Data de criação)	createdDate	date-time
Data de expiração	expirationDate	date-time
documentFileId	files.documentFileId	uuid
id	id	uuid
Introdução	introduction	string
linguagem	language	string
lineItems	lineItems	array of object
alternativa	lineItems.alternative	boolean
discountPercentage	lineItems.discountPercentage	number
id	lineItems.id	uuid
LineItemAmount	lineItems.lineItemAmount	number
nome	lineItems.name	string
optional	lineItems.optional	boolean
quantidade	lineItems.quantity	number
subItens	lineItems.subItems	array of object
alternativa	lineItems.subItems.alternative	boolean
discountPercentage	lineItems.subItems.discountPercentage	number
id	lineItems.subItems.id	uuid
LineItemAmount	lineItems.subItems.lineItemAmount	number
nome	lineItems.subItems.name	string
optional	lineItems.subItems.optional	boolean
quantidade	lineItems.subItems.quantity	number
tipo	lineItems.subItems.type	string
Nome da unidade	lineItems.subItems.unitName	string
moeda	lineItems.subItems.unitPrice.currency	string
Montante bruto	lineItems.subItems.unitPrice.grossAmount	number
montante líquido	lineItems.subItems.unitPrice.netAmount	number
taxRatePercentagem	lineItems.subItems.unitPrice.taxRatePercentage	number
tipo	lineItems.type	string
Nome da unidade	lineItems.unitName	string
moeda	lineItems.unitPrice.currency	string
Montante bruto	lineItems.unitPrice.grossAmount	number
montante líquido	lineItems.unitPrice.netAmount	number
taxRatePercentagem	lineItems.unitPrice.taxRatePercentage	number
organizationId	organizationId	uuid
discountPercentage	paymentConditions.paymentDiscountConditions.discountPercentage	number
Gama de desconto	paymentConditions.paymentDiscountConditions.discountRange	integer
PagamentoPrazoDuração	paymentConditions.paymentTermDuration	integer
pagamentoTermoRótulo	paymentConditions.paymentTermLabel	string
TermoModelo de RótuloPagamento	paymentConditions.paymentTermLabelTemplate	string
comentário	remark	string
ImpostosValores	taxAmounts	array of object
montante líquido	taxAmounts.netAmount	number
taxMontante	taxAmounts.taxAmount	number
taxRatePercentagem	taxAmounts.taxRatePercentage	number
Tipo de Imposto	taxConditions.taxType	string
title	title	string
moeda	totalPrice.currency	string
totalQuantumBrutoValor	totalPrice.totalGrossAmount	number
totalNetAmount	totalPrice.totalNetAmount	number
totalTaxAmount	totalPrice.totalTaxAmount	number
atualizadoData de atualização	updatedDate	date-time
versão	version	integer
voucherData	voucherDate	date-time
voucherNumber	voucherNumber	string
Estado do voucher	voucherStatus	string

Recuperar uma Confirmação de Encomenda

ID da Operação:: RetrieveOrderConfirmation

Devolve a confirmação da encomenda com o valor id {id}.

Parâmetros

Name	Chave	Necessário	Tipo	Description
Id	id	True	string	Especifique o ID.

Devoluções

Name	Caminho	Tipo
city	address.city	string
Código do país	address.countryCode	string
nome	address.name	string
rua	address.street	string
Suplemento	address.supplement	string
ZIP	address.zip	string
arquivado	archived	boolean
createdDate (Data de criação)	createdDate	date-time
Termos de entrega	deliveryTerms	string
documentFileId	files.documentFileId	uuid
id	id	uuid
Introdução	introduction	string
linguagem	language	string
lineItems	lineItems	array of object
discountPercentage	lineItems.discountPercentage	number
id	lineItems.id	uuid
LineItemAmount	lineItems.lineItemAmount	number
nome	lineItems.name	string
quantidade	lineItems.quantity	number
tipo	lineItems.type	string
Nome da unidade	lineItems.unitName	string
moeda	lineItems.unitPrice.currency	string
Montante bruto	lineItems.unitPrice.grossAmount	number
montante líquido	lineItems.unitPrice.netAmount	number
taxRatePercentagem	lineItems.unitPrice.taxRatePercentage	number
organizationId	organizationId	uuid
discountPercentage	paymentConditions.paymentDiscountConditions.discountPercentage	number
Gama de desconto	paymentConditions.paymentDiscountConditions.discountRange	integer
PagamentoPrazoDuração	paymentConditions.paymentTermDuration	integer
pagamentoTermoRótulo	paymentConditions.paymentTermLabel	string
TermoModelo de RótuloPagamento	paymentConditions.paymentTermLabelTemplate	string
comentário	remark	string
data de envio	shippingConditions.shippingDate	date-time
ShipType	shippingConditions.shippingType	string
ImpostosValores	taxAmounts	array of object
montante líquido	taxAmounts.netAmount	number
taxMontante	taxAmounts.taxAmount	number
taxRatePercentagem	taxAmounts.taxRatePercentage	number
Tipo de Imposto	taxConditions.taxType	string
title	title	string
moeda	totalPrice.currency	string
totalQuantumBrutoValor	totalPrice.totalGrossAmount	number
totalNetAmount	totalPrice.totalNetAmount	number
totalTaxAmount	totalPrice.totalTaxAmount	number
atualizadoData de atualização	updatedDate	date-time
versão	version	integer
voucherData	voucherDate	date-time
voucherNumber	voucherNumber	string
Estado do voucher	voucherStatus	string

Recuperar uma Fatura

ID da Operação:: RetrieveInvoice

Devolve a fatura com o valor de identificação {id}.

Parâmetros

Name	Chave	Necessário	Tipo	Description
Id	id	True	string	Especifique o ID.

Devoluções

Name	Caminho	Tipo
city	address.city	string
Código do país	address.countryCode	string
nome	address.name	string
rua	address.street	string
Suplemento	address.supplement	string
ZIP	address.zip	string
arquivado	archived	boolean
createdDate (Data de criação)	createdDate	date-time
id	id	uuid
Introdução	introduction	string
linguagem	language	string
lineItems	lineItems	array of object
discountPercentage	lineItems.discountPercentage	number
id	lineItems.id	uuid
LineItemAmount	lineItems.lineItemAmount	number
nome	lineItems.name	string
quantidade	lineItems.quantity	number
tipo	lineItems.type	string
Nome da unidade	lineItems.unitName	string
moeda	lineItems.unitPrice.currency	string
Montante bruto	lineItems.unitPrice.grossAmount	number
montante líquido	lineItems.unitPrice.netAmount	number
taxRatePercentagem	lineItems.unitPrice.taxRatePercentage	number
organizationId	organizationId	uuid
discountPercentage	paymentConditions.paymentDiscountConditions.discountPercentage	number
Gama de desconto	paymentConditions.paymentDiscountConditions.discountRange	integer
PagamentoPrazoDuração	paymentConditions.paymentTermDuration	integer
pagamentoTermoRótulo	paymentConditions.paymentTermLabel	string
TermoModelo de RótuloPagamento	paymentConditions.paymentTermLabelTemplate	string
comentário	remark	string
data de envio	shippingConditions.shippingDate	date-time
ShipType	shippingConditions.shippingType	string
ImpostosValores	taxAmounts	array of object
montante líquido	taxAmounts.netAmount	number
taxMontante	taxAmounts.taxAmount	number
taxRatePercentagem	taxAmounts.taxRatePercentage	number
Tipo de Imposto	taxConditions.taxType	string
title	title	string
moeda	totalPrice.currency	string
totalQuantumBrutoValor	totalPrice.totalGrossAmount	number
totalNetAmount	totalPrice.totalNetAmount	number
totalTaxAmount	totalPrice.totalTaxAmount	number
atualizadoData de atualização	updatedDate	date-time
versão	version	integer
voucherData	voucherDate	date-time
voucherNumber	voucherNumber	string
Estado do voucher	voucherStatus	string

Recuperar uma Lista de Categorias de Publicação

ID da Operação:: RetrieveListPostingCategories

Este endpoint fornece acesso de leitura à lista de categorias de publicação para as receitas ou despesas (de contabilidade) que são suportadas no lexoffice.

Devoluções

response: array of Response_posting-categories_get_items

Recuperar uma Nota de Crédito

ID da Operação:: RetrieveCreditNote

Este endpoint oferece acesso de leitura e escrita às notas de crédito e também a possibilidade de apresentar o documento em PDF para o descarregar. As notas de crédito podem ser criadas em rascunho ou finalizadas em modo aberto.

Parâmetros

Name	Chave	Necessário	Tipo	Description
Id	id	True	string	Especifique o ID.

Devoluções

Name	Caminho	Tipo
city	address.city	string
Código do país	address.countryCode	string
nome	address.name	string
rua	address.street	string
Suplemento	address.supplement	string
ZIP	address.zip	string
arquivado	archived	boolean
createdDate (Data de criação)	createdDate	date-time
id	id	uuid
Introdução	introduction	string
linguagem	language	string
lineItems	lineItems	array of object
LineItemAmount	lineItems.lineItemAmount	number
nome	lineItems.name	string
quantidade	lineItems.quantity	number
tipo	lineItems.type	string
Nome da unidade	lineItems.unitName	string
moeda	lineItems.unitPrice.currency	string
Montante bruto	lineItems.unitPrice.grossAmount	float
montante líquido	lineItems.unitPrice.netAmount	float
taxRatePercentagem	lineItems.unitPrice.taxRatePercentage	number
organizationId	organizationId	uuid
comentário	remark	string
ImpostosValores	taxAmounts	array of object
montante líquido	taxAmounts.netAmount	number
taxMontante	taxAmounts.taxAmount	number
taxRatePercentagem	taxAmounts.taxRatePercentage	number
Tipo de Imposto	taxConditions.taxType	string
title	title	string
moeda	totalPrice.currency	string
totalQuantumBrutoValor	totalPrice.totalGrossAmount	float
totalNetAmount	totalPrice.totalNetAmount	float
totalTaxAmount	totalPrice.totalTaxAmount	float
atualizadoData de atualização	updatedDate	date-time
versão	version	integer
voucherData	voucherDate	date-time
voucherNumber	voucherNumber	string
Estado do voucher	voucherStatus	string

Recuperar uma Nota de Entrega

ID da Operação:: RetrieveDeliveryNote

Devolve a nota de entrega com valor id {id}.

Parâmetros

Name	Chave	Necessário	Tipo	Description
Id	id	True	string	Especifique o ID.

Devoluções

Name	Caminho	Tipo
city	address.city	string
Código do país	address.countryCode	string
nome	address.name	string
rua	address.street	string
Suplemento	address.supplement	string
ZIP	address.zip	string
arquivado	archived	boolean
createdDate (Data de criação)	createdDate	date-time
Termos de entrega	deliveryTerms	string
id	id	uuid
Introdução	introduction	string
linguagem	language	string
lineItems	lineItems	array of object
nome	lineItems.name	string
quantidade	lineItems.quantity	number
tipo	lineItems.type	string
Nome da unidade	lineItems.unitName	string
moeda	lineItems.unitPrice.currency	string
Montante bruto	lineItems.unitPrice.grossAmount	number
montante líquido	lineItems.unitPrice.netAmount	number
taxRatePercentagem	lineItems.unitPrice.taxRatePercentage	number
organizationId	organizationId	uuid
comentário	remark	string
Tipo de Imposto	taxConditions.taxType	string
title	title	string
atualizadoData de atualização	updatedDate	date-time
versão	version	integer
voucherData	voucherDate	date-time
voucherNumber	voucherNumber	string
Estado do voucher	voucherStatus	string

Recupere um Voucher

ID da Operação:: RetrieveVoucher

Listar os vales de venda (por exemplo, faturas, notas de crédito)

Parâmetros

Name	Chave	Necessário	Tipo	Description
Id	id	True	string	Especifique o ID.

Devoluções

Name	Caminho	Tipo
createdDate (Data de criação)	createdDate	date-time
data de vencimento	dueDate	date-time
files	files	array of string
id	id	uuid
organizationId	organizationId	uuid
comentário	remark	string
data de envio	shippingDate	date-time
Tipo de Imposto	taxType	string
totalQuantumBrutoValor	totalGrossAmount	number
totalTaxAmount	totalTaxAmount	number
tipo	type	string
atualizadoData de atualização	updatedDate	date-time
useCollectiveContact	useCollectiveContact	boolean
versão	version	integer
voucherData	voucherDate	date-time
Itens do voucher	voucherItems	array of object
Montante	voucherItems.amount	number
categoryId	voucherItems.categoryId	uuid
taxMontante	voucherItems.taxAmount	number
taxTaxPercentagem	voucherItems.taxRatePercent	number
voucherNumber	voucherNumber	string
Estado do voucher	voucherStatus	string

Recupere uma Fatura de Entrada

ID da Operação:: RetrieveDownPaymentInvoice

Devolve a fatura de entrada com valor de identificação {id}.

Parâmetros

Name	Chave	Necessário	Tipo	Description
Id	id	True	string	Especifique o ID.

Devoluções

Name	Caminho	Tipo
city	address.city	string
Código do país	address.countryCode	string
nome	address.name	string
rua	address.street	string
Suplemento	address.supplement	string
ZIP	address.zip	string
arquivado	archived	boolean
closingInvoiceId	closingInvoiceId	uuid
createdDate (Data de criação)	createdDate	date-time
data de vencimento	dueDate	date-time
documentFileId	files.documentFileId	uuid
id	id	uuid
Introdução	introduction	string
linguagem	language	string
lineItems	lineItems	array of object
LineItemAmount	lineItems.lineItemAmount	number
nome	lineItems.name	string
quantidade	lineItems.quantity	number
tipo	lineItems.type	string
moeda	lineItems.unitPrice.currency	string
Montante bruto	lineItems.unitPrice.grossAmount	number
montante líquido	lineItems.unitPrice.netAmount	number
taxRatePercentagem	lineItems.unitPrice.taxRatePercentage	number
organizationId	organizationId	uuid
discountPercentage	paymentConditions.paymentDiscountConditions.discountPercentage	number
Gama de desconto	paymentConditions.paymentDiscountConditions.discountRange	integer
PagamentoPrazoDuração	paymentConditions.paymentTermDuration	integer
pagamentoTermoRótulo	paymentConditions.paymentTermLabel	string
TermoModelo de RótuloPagamento	paymentConditions.paymentTermLabelTemplate	string
comentário	remark	string
ShipType	shippingConditions.shippingType	string
ImpostosValores	taxAmounts	array of object
montante líquido	taxAmounts.netAmount	number
taxMontante	taxAmounts.taxAmount	number
taxRatePercentagem	taxAmounts.taxRatePercentage	number
Tipo de Imposto	taxConditions.taxType	string
title	title	string
moeda	totalPrice.currency	string
totalQuantumBrutoValor	totalPrice.totalGrossAmount	number
totalNetAmount	totalPrice.totalNetAmount	number
totalTaxAmount	totalPrice.totalTaxAmount	number
atualizadoData de atualização	updatedDate	date-time
versão	version	integer
voucherData	voucherDate	date-time
voucherNumber	voucherNumber	string
Estado do voucher	voucherStatus	string

Recupere uma Subscrição de Evento

ID da Operação:: RetrieveAEventSubscription

Recupere uma Subscrição de Evento

Parâmetros

Name	Chave	Necessário	Tipo	Description
ID da Subscrição	subscriptionId	True	string	Especifique o ID da subscrição.

Devoluções

Body: EventSubscriptionResponse

Renderizar um documento de dunning (PDF)

ID da Operação:: RenderDunningDocument

Para descarregar o ficheiro pdf de um documento de dunning, precisa do seu documentFileId. Este id é normalmente devolvido pelo recurso de dunning. No entanto, os dunnings recém-criados através da API têm de ativar separadamente a renderização do ficheiro do documento PDF. Isto pode ser feito com este endpoint.

Parâmetros

Name	Chave	Necessário	Tipo	Description
Dunningsid	dunningsid	True	string	Especifique o dunningsid.

Devoluções

Name	Caminho	Tipo	Description
documentFileId	documentFileId	uuid

Voucher de Atualização

ID da Operação:: UpdateVoucher

Atualizar um voucher

Parâmetros

Name	Chave	Necessário	Tipo	Description
Id	id	True	string	Especifique o ID.
contactId	contactId		string
data de vencimento	dueDate		date
files	files		array of string	lista de omitir fileIds
comentário	remark		string
data de envio	shippingDate		date
Tipo de Imposto	taxType	True	string
totalQuantumBrutoValor	totalGrossAmount		float
totalTaxAmount	totalTaxAmount		float
tipo	type	True	string
useCollectiveContact	useCollectiveContact		boolean
versão	version		integer
voucherData	voucherDate		date
Montante	amount		float
categoryId	categoryId		string
taxMontante	taxAmount		float
taxTaxPercentagem	taxRatePercent		integer
voucherNumber	voucherNumber		string
Estado do voucher	voucherStatus		string

Devoluções

Body: Response_vouchers_id_put

Acionadores

Selecione o seu Trigger personalizado

Registar um novo trigger para o endpoint de contactos

Selecione o seu Trigger personalizado

ID da Operação:: EventSubscription_Lexoffice

Registar um novo trigger para o endpoint de contactos

Parâmetros

Name	Chave	Necessário	Tipo	Description
Tipo de Evento	eventType	True	string	eventType

Devoluções

Name	Caminho	Tipo	Description
data-do-evento	eventDate	string	data-do-evento
eventType	eventType	string	eventType
organizationId	organizationId	string	organizationId
resourceId	resourceId	string	resourceId

Definições

EventoSubscriçãoResposta

Name	Caminho	Tipo
ID de subscrição	subscriptionId	string
eventType	eventType	string
organizationId	organizationId	string
createdDate (Data de criação)	createdDate	date-time
callbackUrl	callbackUrl	string

Response_articles_get

Name	Caminho	Tipo	Description
conteúdo	content	array of object	conteúdo
articleNúmero	content.articleNumber	string	articleNúmero
GTIN	content.gtin	string	GTIN
id	content.id	string	id
Observação	content.note	string	Observação
preço bruto	content.price.grossPrice	float	preço bruto
líder Price	content.price.leadingPrice	string	líder Price
netPreço	content.price.netPrice	float	netPreço
taxRate	content.price.taxRate	float	taxRate
title	content.title	string	title
tipo	content.type	string	tipo
Nome da unidade	content.unitName	string	Nome da unidade
versão	content.version	integer	versão
primeiro	first	boolean	primeiro
último	last	boolean	último
número	number	integer	número
númerodeelementos	numberOfElements	integer	númerodeelementos
size	size	integer	size
ordenar	sort	array of object	ordenar
ascendente	sort.ascending	boolean	ascendente
direção	sort.direction	string	direção
ignorarCaso	sort.ignoreCase	boolean	ignorarCaso
nullHandling	sort.nullHandling	string	nullHandling
propriedade	sort.property	string	propriedade
totalElements	totalElements	integer	totalElements
totalPáginas	totalPages	integer	totalPáginas

Response_articles_id_get

Name	Caminho	Tipo	Description
articleNúmero	articleNumber	string	articleNúmero
GTIN	gtin	string	GTIN
id	id	string	id
Observação	note	string	Observação
preço bruto	price.grossPrice	float	preço bruto
líder Price	price.leadingPrice	string	líder Price
netPreço	price.netPrice	float	netPreço
taxRate	price.taxRate	float	taxRate
title	title	string	title
tipo	type	string	tipo
Nome da unidade	unitName	string	Nome da unidade
versão	version	integer	versão

Response_articles_post

Name	Caminho	Tipo	Description
createdDate (Data de criação)	createdDate	string	createdDate (Data de criação)
id	id	string	id
resourceUri	resourceUri	string	resourceUri
atualizadoData de atualização	updatedDate	string	atualizadoData de atualização
versão	version	integer	versão

Response_contacts_get

Name	Caminho	Tipo	Description
conteúdo	content	array of object	conteúdo
faturação	content.addresses.billing	array of object	faturação
city	content.addresses.billing.city	string	city
Código do país	content.addresses.billing.countryCode	string	Código do país
rua	content.addresses.billing.street	string	rua
Suplemento	content.addresses.billing.supplement	string	Suplemento
ZIP	content.addresses.billing.zip	string	ZIP
envio	content.addresses.shipping	array of object	envio
city	content.addresses.shipping.city	string	city
Código do país	content.addresses.shipping.countryCode	string	Código do país
rua	content.addresses.shipping.street	string	rua
Suplemento	content.addresses.shipping.supplement	string	Suplemento
ZIP	content.addresses.shipping.zip	string	ZIP
arquivado	content.archived	boolean	arquivado
allowTaxFreeFaturas	content.company.allowTaxFreeInvoices	boolean	allowTaxFreeFaturas
ContactPersons	content.company.contactPersons	array of object	ContactPersons
endereço de e-mail	content.company.contactPersons.emailAddress	string	endereço de e-mail
primeiroNome	content.company.contactPersons.firstName	string	primeiroNome
sobrenome	content.company.contactPersons.lastName	string	sobrenome
primário	content.company.contactPersons.primary	boolean	primário
saudação	content.company.contactPersons.salutation	string	saudação
nome	content.company.name	string	nome
Número de contribuinte	content.company.taxNumber	string	Número de contribuinte
vatRegistrationId	content.company.vatRegistrationId	string	vatRegistrationId
negócios	content.emailAddresses.business	array of string	negócios
escritório	content.emailAddresses.office	array of string	escritório
other	content.emailAddresses.other	array of string	other
id	content.id	string	id
Observação	content.note	string	Observação
organizationId	content.organizationId	string	organizationId
negócios	content.phoneNumbers.business	array of string	negócios
Fax	content.phoneNumbers.fax	array of string	Fax
escritório	content.phoneNumbers.office	array of string	escritório
other	content.phoneNumbers.other	array of string	other
número	content.roles.customer.number	integer	número
número	content.roles.vendor.number	integer	número
versão	content.version	integer	versão
primeiro	first	boolean	primeiro
último	last	boolean	último
número	number	integer	número
númerodeelementos	numberOfElements	integer	númerodeelementos
size	size	integer	size
ordenar	sort	array of object	ordenar
ascendente	sort.ascending	boolean	ascendente
direção	sort.direction	string	direção
ignorarCaso	sort.ignoreCase	boolean	ignorarCaso
nullHandling	sort.nullHandling	string	nullHandling
propriedade	sort.property	string	propriedade
totalElements	totalElements	integer	totalElements
totalPáginas	totalPages	integer	totalPáginas

Response_contacts_post

Name	Caminho	Tipo	Description
createdDate (Data de criação)	createdDate	string	createdDate (Data de criação)
id	id	string	id
resourceUri	resourceUri	string	resourceUri
atualizadoData de atualização	updatedDate	string	atualizadoData de atualização
versão	version	integer	versão

Response_countries_get_default

Name	Caminho	Tipo	Description
Código do país	countryCode	string	Código do país
paísNomeDE	countryNameDE	string	paísNomeDE
paísNomeEN	countryNameEN	string	paísNomeEN
Classificação fiscal	taxClassification	string	Classificação fiscal

Response_credit-notes_post

Name	Caminho	Tipo	Description
createdDate (Data de criação)	createdDate	string	createdDate (Data de criação)
id	id	string	id
resourceUri	resourceUri	string	resourceUri
atualizadoData de atualização	updatedDate	string	atualizadoData de atualização
versão	version	integer	versão

Response_delivery-notes_post

Name	Caminho	Tipo	Description
createdDate (Data de criação)	createdDate	string	createdDate (Data de criação)
id	id	string	id
resourceUri	resourceUri	string	resourceUri
atualizadoData de atualização	updatedDate	string	atualizadoData de atualização
versão	version	integer	versão

Response_dunnings_post

Name	Caminho	Tipo	Description
createdDate (Data de criação)	createdDate	string	createdDate (Data de criação)
id	id	string	id
resourceUri	resourceUri	string	resourceUri
atualizadoData de atualização	updatedDate	string	atualizadoData de atualização
versão	version	integer	versão

Response_event-subscriptions_get

Name	Caminho	Tipo	Description
conteúdo	content	array of object	conteúdo
callbackUrl	content.callbackUrl	string	callbackUrl
createdDate (Data de criação)	content.createdDate	string	createdDate (Data de criação)
eventType	content.eventType	string	eventType
organizationId	content.organizationId	string	organizationId
ID de subscrição	content.subscriptionId	string	ID de subscrição

Response_files_post

Name	Caminho	Tipo	Description
id	id	string	id

Response_invoices_post

Name	Caminho	Tipo	Description
createdDate (Data de criação)	createdDate	string	createdDate (Data de criação)
id	id	string	id
resourceUri	resourceUri	string	resourceUri
atualizadoData de atualização	updatedDate	string	atualizadoData de atualização
versão	version	integer	versão

Response_order-confirmations_post

Name	Caminho	Tipo	Description
createdDate (Data de criação)	createdDate	string	createdDate (Data de criação)
id	id	string	id
resourceUri	resourceUri	string	resourceUri
atualizadoData de atualização	updatedDate	string	atualizadoData de atualização
versão	version	integer	versão

Response_payment-conditions_get_items

Name	Caminho	Tipo	Description
id	id	string	id
organizationDefault	organizationDefault	boolean	organizationDefault
discountPercentage	paymentDiscountConditions.discountPercentage	integer	discountPercentage
Gama de desconto	paymentDiscountConditions.discountRange	integer	Gama de desconto
PagamentoPrazoDuração	paymentTermDuration	integer	PagamentoPrazoDuração
TermoModelo de RótuloPagamento	paymentTermLabelTemplate	string	TermoModelo de RótuloPagamento

Response_posting-categories_get_items

Name	Caminho	Tipo	Description
contactRequired	contactRequired	boolean	contactRequired
groupName	groupName	string	groupName
id	id	string	id
nome	name	string	nome
splitPermitido	splitAllowed	boolean	splitPermitido
tipo	type	string	tipo

Response_profile_get

Name	Caminho	Tipo	Description
NegóciosFuncionalidades	businessFeatures	array of string	NegóciosFuncionalidades
companyName	companyName	string	companyName
connectionId	connectionId	string	connectionId
date	created.date	string	date
usuárioE-mail	created.userEmail	string	usuárioE-mail
userId	created.userId	string	userId
nome de utilizador	created.userName	string	nome de utilizador
features	features	array of string	features
organizationId	organizationId	string	organizationId
Pequenas Empresas	smallBusiness	boolean	Pequenas Empresas
subscriptionStatus	subscriptionStatus	string	subscriptionStatus
Tipo de Imposto	taxType	string	Tipo de Imposto

Response_quotations_post

Name	Caminho	Tipo	Description
createdDate (Data de criação)	createdDate	string	createdDate (Data de criação)
id	id	string	id
resourceUri	resourceUri	string	resourceUri
atualizadoData de atualização	updatedDate	string	atualizadoData de atualização
versão	version	integer	versão

Response_recurring-templates_get

Name	Caminho	Tipo	Description
conteúdo	content	array of object	conteúdo
contactId	content.address.contactId	string	contactId
nome	content.address.name	string	nome
createdDate (Data de criação)	content.createdDate	string	createdDate (Data de criação)
id	content.id	string	id
organizationId	content.organizationId	string	organizationId
discountPercentage	content.paymentConditions.paymentDiscountConditions.discountPercentage	integer	discountPercentage
Gama de desconto	content.paymentConditions.paymentDiscountConditions.discountRange	integer	Gama de desconto
PagamentoPrazoDuração	content.paymentConditions.paymentTermDuration	integer	PagamentoPrazoDuração
pagamentoTermoRótulo	content.paymentConditions.paymentTermLabel	string	pagamentoTermoRótulo
TermoModelo de RótuloPagamento	content.paymentConditions.paymentTermLabelTemplate	string	TermoModelo de RótuloPagamento
data de término	content.recurringTemplateSettings.endDate	string	data de término
executionInterval	content.recurringTemplateSettings.executionInterval	string	executionInterval
ExecuçãoEstado	content.recurringTemplateSettings.executionStatus	string	ExecuçãoEstado
finalizar	content.recurringTemplateSettings.finalize	boolean	finalizar
id	content.recurringTemplateSettings.id	string	id
últimoExecuçãoFalhada	content.recurringTemplateSettings.lastExecutionFailed	boolean	últimoExecuçãoFalhada
nextData de execução	content.recurringTemplateSettings.nextExecutionDate	string	nextData de execução
ShipType	content.recurringTemplateSettings.shippingType	string	ShipType
startDate	content.recurringTemplateSettings.startDate	string	startDate
title	content.title	string	title
moeda	content.totalPrice.currency	string	moeda
totalQuantumBrutoValor	content.totalPrice.totalGrossAmount	integer	totalQuantumBrutoValor
totalNetAmount	content.totalPrice.totalNetAmount	float	totalNetAmount
atualizadoData de atualização	content.updatedDate	string	atualizadoData de atualização
primeiro	first	boolean	primeiro
último	last	boolean	último
número	number	integer	número
númerodeelementos	numberOfElements	integer	númerodeelementos
size	size	integer	size
ordenar	sort	array of object	ordenar
ascendente	sort.ascending	boolean	ascendente
direção	sort.direction	string	direção
ignorarCaso	sort.ignoreCase	boolean	ignorarCaso
nullHandling	sort.nullHandling	string	nullHandling
propriedade	sort.property	string	propriedade
totalElements	totalElements	integer	totalElements
totalPáginas	totalPages	integer	totalPáginas

Response_voucherlist_get

Name	Caminho	Tipo	Description
conteúdo	content	array of object	conteúdo
arquivado	content.archived	boolean	arquivado
contactId	content.contactId	string	contactId
nomedocontato	content.contactName	string	nomedocontato
createdDate (Data de criação)	content.createdDate	string	createdDate (Data de criação)
moeda	content.currency	string	moeda
data de vencimento	content.dueDate	string	data de vencimento
id	content.id	string	id
openAmount	content.openAmount	float	openAmount
Montante Total	content.totalAmount	float	Montante Total
atualizadoData de atualização	content.updatedDate	string	atualizadoData de atualização
voucherData	content.voucherDate	string	voucherData
voucherNumber	content.voucherNumber	string	voucherNumber
Estado do voucher	content.voucherStatus	string	Estado do voucher
voucherType	content.voucherType	string	voucherType
primeiro	first	boolean	primeiro
último	last	boolean	último
número	number	integer	número
númerodeelementos	numberOfElements	integer	númerodeelementos
size	size	integer	size
ordenar	sort	array of object	ordenar
ascendente	sort.ascending	boolean	ascendente
direção	sort.direction	string	direção
ignorarCaso	sort.ignoreCase	boolean	ignorarCaso
nullHandling	sort.nullHandling	string	nullHandling
propriedade	sort.property	string	propriedade
totalElements	totalElements	integer	totalElements
totalPáginas	totalPages	integer	totalPáginas

Response_vouchers_post

Name	Caminho	Tipo	Description
createdDate (Data de criação)	createdDate	string	createdDate (Data de criação)
id	id	string	id
resourceUri	resourceUri	string	resourceUri
atualizadoData de atualização	updatedDate	string	atualizadoData de atualização
versão	version	integer	versão

Response_contacts_id_put

Name	Caminho	Tipo
arquivado	archived	boolean
id	id	uuid
organizationId	organizationId	uuid
primeiroNome	person.firstName	string
sobrenome	person.lastName	string
saudação	person.salutation	string
número	roles.customer.number	integer
versão	version	integer

Response_vouchers_id_put

Name	Caminho	Tipo
createdDate (Data de criação)	createdDate	date-time
data de vencimento	dueDate	date-time
files	files	array of object
items	files	object
id	id	uuid
organizationId	organizationId	uuid
comentário	remark	string
data de envio	shippingDate	date-time
Tipo de Imposto	taxType	string
totalQuantumBrutoValor	totalGrossAmount	number
totalTaxAmount	totalTaxAmount	number
tipo	type	string
atualizadoData de atualização	updatedDate	date-time
useCollectiveContact	useCollectiveContact	boolean
versão	version	integer
voucherData	voucherDate	date-time
Itens do voucher	voucherItems	array of object
Montante	voucherItems.amount	number
categoryId	voucherItems.categoryId	uuid
taxMontante	voucherItems.taxAmount	number
taxTaxPercentagem	voucherItems.taxRatePercent	number
voucherNumber	voucherNumber	string
Estado do voucher	voucherStatus	string

ficheiro

Este é o tipo de dados básicos 'arquivo'.

Partilhar via

Lexoffice (Editora Independente) (Pré-visualização)

Lexware API Connector (Editor Independente)

Editora: Independent Publisher

Pré-requisitos

Operações suportadas

Obtenção de credenciais

Gateway de API

Limites de Taxa

Authentication

Exemplo de Utilização

Problemas conhecidos e limitações

Documentação da API

A criar uma ligação

Padrão

Limites de Limitação

Ações

Apaga um Event-Subscription

Parâmetros

Apresentar um Documento de Citação (PDF)

Parâmetros

Devoluções

Apresentar um Documento de Fatura (PDF)

Parâmetros

Devoluções

Apresentar um Documento de Nota de Crédito (PDF)

Parâmetros

Devoluções

Apresentar um Documento de Nota de Entrega (PDF)

Parâmetros

Devoluções

Atualizar um artigo

Parâmetros

Devoluções

Atualizar um contato

Parâmetros

Devoluções

Carregar um ficheiro

Parâmetros

Devoluções

Carregar um ficheiro para um Voucher

Parâmetros

Criar um artigo

Parâmetros

Devoluções

Criar um contacto

Devoluções

Criar um mergulho

Parâmetros

Devoluções

Criar uma Cotação

Parâmetros

Devoluções

Criar uma Fatura

Parâmetros

Devoluções

Criar uma Nota de Entrega

Parâmetros

Devoluções

Crie um Voucher

Parâmetros

Devoluções

Crie uma Confirmação de Encomenda

Parâmetros

Devoluções

Crie uma Nota de Crédito

Parâmetros

Devoluções

Descarregar um ficheiro

Parâmetros

Devoluções

Eliminar um artigo

Parâmetros

Emitir um Documento de Confirmação de Ordem (PDF)

Parâmetros

Devoluções

Filtragem de Artigos

Parâmetros

Devoluções

Recuperar e Filtrar Lista de Vouchers