Lexoffice (Editor Independente) (versão prévia)

A API do Lexware fornece acesso programático às principais funcionalidades de negócios do Lexware, como artigos, contatos, faturas, pedidos e gerenciamento de arquivos. Esse conector independente do Publisher permite a integração segura com a API REST do Lexware, permitindo que os usuários criem e recuperem dados comerciais, automatizem processos e conectem recursos do Lexware com aplicativos do Power Platform. O conector usa o Fluxo de Código de Autorização do OAuth 2.0 para autenticação segura e diretrizes de API.

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

Service	Class	Regions
Copilot Studio	Premium	Todas as regiões do Power Automate , exceto as seguintes: – Governo dos EUA (GCC) – Governo dos EUA (GCC High) - China Cloud operado pela 21Vianet - Departamento de Defesa dos EUA (DoD)
Aplicativos Lógicos	Standard	Todas as regiões dos Aplicativos Lógicos , exceto as seguintes: – Regiões do Azure Governamental - Regiões do Azure China - Departamento de Defesa dos EUA (DoD)
Power Apps	Premium	Todas as regiões do Power Apps , exceto as seguintes: – Governo dos EUA (GCC) – Governo dos EUA (GCC High) - China Cloud operado pela 21Vianet - Departamento de Defesa dos EUA (DoD)
Power Automate	Premium	Todas as regiões do Power Automate , exceto as seguintes: – Governo dos EUA (GCC) – Governo dos EUA (GCC High) - China Cloud operado pela 21Vianet - Departamento de Defesa dos EUA (DoD)

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

Metadados do conector
Publicador	LowCodeInvestigator
Site da Web	https://office.lexware.de/
Política de privacidade	https://office.lexware.de/datenschutz/
Categorias	Gestão de empresas; Financiar

Conector de API do Lexware (Editor Independente)

A API do Lexware é uma interface RESTful que permite que os desenvolvedores integrem funções comerciais do Lexware, como contatos, faturas, artigos e arquivos em seus próprios aplicativos. Esse conector permite interação direta com esses recursos por meio de solicitações de API seguras e autenticadas.

Publicador: Publicador Independente

Pré-requisitos

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

Operações com suporte

Esse conector dá suporte aos seguintes pontos de extremidade da API lexware:

Artigos: Criar, recuperar, atualizar, excluir e filtrar artigos
Contatos: Gerenciar dados do cliente e do fornecedor
Faturas: Criar e recuperar dados da fatura, incluindo a renderização de PDFs
Notas de crédito, notas de entrega, pedidos, aspas e vouchers
Países, Condições de Pagamento, Layouts de Impressão e Perfis
Assinaturas e arquivos de eventos
Lista completa documentada em: Documentos da API do Lexware

Obtendo credenciais

Para chamar a API do Lexware, você precisa de uma chave de API:

Entre em sua conta do Lexware Office.
Navegue até Extensões → Aplicativos Weitere → API Pública ou aberta
O Portal do Desenvolvedor do Lexware diretamente.
Crie uma nova chave de API com as permissões desejadas.
Copie a chave de API gerada. Esse valor será usado como accessToken no conector.

Gateway de API

Use o novo gateway de API do Lexware:

https://api.lexware.io

Limites de taxa

Máximo de 2 solicitações/segundo
Solicitações que excedem esse limite recebem HTTP 429 Too Many Requests
Recomendado: Usar algoritmo de bucket de token ou retirada exponencial

Authentication

A API do Lexware usa o fluxo de código de autorização do OAuth 2.0. Inclua o token no Authorization: Bearer {accessToken} cabeçalho de cada solicitação.

Exemplo de Uso

Criando 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 e limitações conhecidos

Máximo de 2 solicitações/segundo
Alguns pontos de extremidade exigem 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/

Criando uma conexão

O conector dá suporte aos seguintes tipos de autenticação:


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

Padrão

Aplicável: todas as regiões

Parâmetros para criar conexão.

Essa não é uma conexão compartilhável. Se o aplicativo de energia for compartilhado com outro usuário, outro usuário será solicitado a criar uma nova conexão explicitamente.

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

Limitações

Nome	Chamadas	Período de renovação
Chamadas à API por conexão	100	60 segundos

Ações

Atualizar um artigo	Atualize um artigo existente com id {id} com os dados dados dados no conteúdo como JSON. Retorna um resultado de ação com êxito.
Atualizar um contato	Atualizar um contato
Atualizar Voucher	Atualizar um voucher
Baixar um arquivo	Use esse ponto de extremidade para baixar arquivos.
Carregar um arquivo	Use esse ponto de extremidade para carregar arquivos, por exemplo, vouchers ou faturas.
Carregar um arquivo em um voucher	Carregue e atribua arquivos (pdf ou imagem) ao voucher identificado por {id}.
Criar um artigo	O conteúdo do artigo é esperado no corpo da solicitação como um aplicativo/json.
Criar um contato	Criar um novo contato
Criar um dunning	O dunning criado não será mostrado na lista principal de vouchers no lexoffice, mas será anexado a uma fatura e ficará visível lá. Para fornecer aos clientes acesso ao dunning criado, use nossa função deeplink.
Criar um voucher	Criar vouchers (restritos a vouchers de vendas)
Criar uma confirmação de pedido	Esse ponto de extremidade fornece acesso de leitura e gravação a confirmações de pedidos e também a possibilidade de renderizar o documento como UM PDF para baixá-lo. As confirmações de pedido são sempre criadas no modo de rascunho e não precisam ser finalizadas.
Criar uma cotação	As aspas transmitidas por meio da API são criadas no modo de rascunho por padrão. Para criar uma aspa finalizada com o status, abra a finalização do parâmetro de consulta opcional. O status de uma aspa não pode ser alterado por meio da api.
Criar uma fatura	As faturas transmitidas por meio da API são criadas no modo de rascunho por padrão. Para criar uma fatura finalizada com status, abra a finalização do parâmetro de consulta opcional. O status de uma fatura não pode ser alterado por meio da api.
Criar uma nota de crédito	As notas de crédito transmitidas por meio da API são criadas no modo de rascunho por padrão. Para criar uma nota de crédito finalizada com status, abra a finalização do parâmetro de consulta opcional. O status de uma nota de crédito não pode ser alterado por meio 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 por meio da API são criadas somente no modo de rascunho.
Excluir um artigo	Exclui o artigo com o valor da ID {id}. Retorna 204 com êxito ou 404 se a ID não existir.
Excluir um Event-Subscription	Excluir WebHook de Gatilho
Filtrando artigos	Retorna os artigos que atendem aos critérios dados por filtros filter_1 para filter_n usando um mecanismo de paginação. Se mais de um filtro for dado, o conector lógico será AND. Os filtros que não estão definidos são ignorados. Para verificar o tamanho máximo da página para esse ponto de extremidade, consulte Paginação de Recursos.
Recuperar e filtrar a lista de vouchers	Obtenha vouchers (contabilidade) (por exemplo, salesinvoices, salescreditnotes), faturas (incluindo faturas de pagamento inativo), notas de crédito, confirmações de pedidos, aspas e notas de entrega.
Recuperar informações de pagamento	O ponto de extremidade de pagamentos fornece acesso de leitura ao status de pagamento de vouchers (contabilidade ou vendas), incluindo faturas e notas de crédito.
Recuperar informações de perfil	O exemplo a seguir mostra como recuperar suas informações básicas de perfil. É necessário substituir o espaço reservado {accessToken} antes de enviar a solicitação.
Recuperar lista de condições de pagamento	O exemplo a seguir mostra como recuperar a lista de condições de pagamento atualmente configuradas. É necessário substituir o espaço reservado {accessToken} antes de enviar a solicitação.
Recuperar lista de países	Lista de países conhecidos por lexoffice.
Recuperar todas as assinaturas de evento	Recuperar todas as assinaturas de evento
Recuperar todos os contatos	Recuperar todos os contatos
Recuperar todos os modelos recorrentes	Recupere uma coleção de modelos recorrentes. O resultado retorna apenas parte dos dados mais relevantes que são o contato referenciado (apenas id e nome), preço total, condições de pagamento e as configurações completas de modelos recorrentes. No entanto, a nomenclatura de objetos e propriedades é a mesma.
Recuperar um artigo	Retorna o artigo com o valor da ID {id}.
Recuperar um contato	Recuperar um contato por ID
Recuperar um dunning	Retorna o dunning com o valor de ID {id}.
Recuperar um modelo recorrente	Retorna o modelo recorrente com o valor da ID {id}.
Recuperar um voucher	Listar vouchers de vendas (por exemplo, faturas, notas de crédito)
Recuperar uma assinatura de evento	Recuperar uma assinatura de evento
Recuperar uma confirmação de pedido	Retorna a confirmação do pedido com o valor da ID {id}.
Recuperar uma cotação	Retorna a aspas com o valor da ID {id}. Renderizar um documento de aspas (PDF)
Recuperar uma fatura	Retorna a fatura com o valor da ID {id}.
Recuperar uma fatura de pagamento inoperante	Retorna a fatura de pagamento inativo com o valor da ID {id}.
Recuperar uma lista de categorias de postagem	Esse ponto de extremidade fornece acesso de leitura à lista de categorias de postagem para a receita ou despesa de vouchers (contabilidade) com suporte no lexoffice.
Recuperar uma nota de crédito	Esse ponto de extremidade fornece acesso de leitura e gravação a notas de crédito e também a possibilidade de renderizar o documento como um PDF para baixá-lo. As notas de crédito podem ser criadas como um rascunho ou finalizadas no modo aberto.
Recuperar uma nota de entrega	Retorna a nota de entrega com o valor da ID {id}.
Renderizar um documento de anotação de crédito (PDF)	Para baixar o arquivo pdf de um documento de anotação de crédito, você precisa de seu documentFileId. Essa ID geralmente é retornada pelo recurso de anotação de crédito. No entanto, as notas de crédito recém-criadas no status aberto por meio da API precisam disparar o arquivo de documento pdf renderizando separadamente. Isso pode ser feito com esse ponto de extremidade.
Renderizar um documento de aspas (PDF)	Para baixar o arquivo pdf de um documento de aspas, você precisa de seu documentFileId. Essa ID geralmente é retornada pelo recurso de aspas. No entanto, as aspas recém-criadas no status aberto por meio da API precisam disparar a renderização separada do arquivo de documento pdf. Isso pode ser feito com esse ponto de extremidade.
Renderizar um documento de confirmação de pedido (PDF)	Para baixar o arquivo pdf de um documento de confirmação de pedido, você precisa de seu documentFileId. Essa ID geralmente é retornada pelo recurso de confirmação do pedido. No entanto, as confirmações de pedido recém-criadas por meio da API precisam disparar a renderização separada do arquivo de documento pdf. Isso pode ser feito com esse ponto de extremidade.
Renderizar um documento de fatura (PDF)	Para baixar o arquivo pdf de um documento de fatura, você precisa de seu documentFileId. Essa ID geralmente é retornada pelo recurso da fatura. No entanto, as faturas recém-criadas no status aberto por meio da API precisam disparar o arquivo de documento pdf renderizando separadamente. Isso pode ser feito com esse ponto de extremidade.
Renderizar um documento de nota de entrega (PDF)	Esse ponto de extremidade fornece acesso de leitura e gravação a notas de entrega e também a possibilidade de renderizar o documento como um PDF para baixá-lo. As notas de entrega são sempre criadas no modo de rascunho e não precisam ser finalizadas.
Renderizar um documento de não-identificação (PDF)	Para baixar o arquivo pdf de um documento de não conformidade, você precisa de seu documentFileId. Essa ID geralmente é retornada pelo recurso de não-identificação. No entanto, os dunnings recém-criados por meio da API precisam disparar a renderização separada do arquivo de documento pdf. Isso pode ser feito com esse ponto de extremidade.

Atualizar um artigo

ID da operação:: UpdateAnArticle

Atualize um artigo existente com id {id} com os dados dados dados no conteúdo como JSON. Retorna um resultado de ação com êxito.

Parâmetros

Nome	Chave	Obrigatório	Tipo	Description
ID	id	True	string	Especifique a ID.
articleNumber	articleNumber		string	articleNumber
gtin	gtin		string	gtin
nota	note		string	nota
grossPrice	grossPrice	True	float	grossPrice
leadingPrice	leadingPrice	True	string	leadingPrice
netPrice	netPrice	True	float	netPrice
taxa de impostos	taxRate		float	taxa de impostos
title	title		string	title
tipo	type	True	string	tipo
unitName	unitName	True	string	unitName
versão	version	True	integer	versão

Retornos

Corpo: Response_articles_id_get

Atualizar um contato

ID da operação:: UpdateContact

Atualizar um contato

Parâmetros

Nome	Chave	Obrigatório	Tipo	Description
ID	id	True	string	Especifique a ID.

Retornos

Corpo: Response_contacts_id_put

Atualizar Voucher

ID da operação:: UpdateVoucher

Atualizar um voucher

Parâmetros

Nome	Chave	Obrigatório	Tipo	Description
ID	id	True	string	Especifique a ID.
contactId	contactId		string
dueDate	dueDate		date
arquivos	files		array of string	lista de fileIds omitidos
comentário	remark		string
shippingDate	shippingDate		date
taxType	taxType	True	string
totalGrossAmount	totalGrossAmount		float
totalTaxAmount	totalTaxAmount		float
tipo	type	True	string
useCollectiveContact	useCollectiveContact		boolean
versão	version		integer
voucherDate	voucherDate		date
quantidade	amount		float
categoryId	categoryId		string
taxAmount	taxAmount		float
taxRatePercent	taxRatePercent		integer
voucherNumber	voucherNumber		string
voucherStatus	voucherStatus		string

Retornos

Corpo: Response_vouchers_id_put

Baixar um arquivo

ID da operação:: DownloadFile_Lexoffice

Use esse ponto de extremidade para baixar arquivos.

Parâmetros

Nome	Chave	Obrigatório	Tipo	Description
ID do arquivo	fileId	True	string	Especifique a ID do arquivo.
Aceitar	Accept		string	Especifique a aceitação.

Retornos

response: file

Carregar um arquivo

ID da operação:: UploadFile_Lexoffice

Use esse ponto de extremidade para carregar arquivos, por exemplo, vouchers ou faturas.

Parâmetros

Nome	Chave	Obrigatório	Tipo	Description
File	file	True	file	O arquivo a ser carregado.
Tipo	type	True	string	Descrição do conteúdo do arquivo.

Retornos

Corpo: Response_files_post

Carregar um arquivo em um voucher

ID da operação:: UploadFileVoucher_Lexoffice

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

Parâmetros

Nome	Chave	Obrigatório	Tipo	Description
ID	id	True	string	Especifique a ID.
File	file	True	file	O arquivo a ser carregado.

Criar um artigo

ID da operação:: CreateArticle

O conteúdo do artigo é esperado no corpo da solicitação como um aplicativo/json.

Parâmetros

Nome	Chave	Tipo	Description
articleNumber	articleNumber	string	articleNumber
grossPrice	grossPrice	float	grossPrice
leadingPrice	leadingPrice	string	leadingPrice
netPrice	netPrice	float	netPrice
taxa de impostos	taxRate	float	taxa de impostos
title	title	string	title
tipo	type	string	tipo
unitName	unitName	string	unitName

Retornos

Corpo: Response_articles_post

Criar um contato

ID da operação:: CreateContact

Criar um novo contato

Retornos

Corpo: Response_contacts_post

Criar um dunning

ID da operação:: CreateDunning

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

Parâmetros

Nome	Chave	Obrigatório	Tipo	Description
ID do voucher de vendas anterior	precedingSalesVoucherId		string	Especifique a ID do voucher de vendas anterior.

Retornos

Corpo: Response_dunnings_post

Criar um voucher

ID da operação:: CreateVoucher

Criar vouchers (restritos a vouchers de vendas)

Parâmetros

Nome	Chave	Obrigatório	Tipo
contactId	contactId		string
dueDate	dueDate		date
comentário	remark		string
shippingDate	shippingDate		date
taxType	taxType	True	string
totalGrossAmount	totalGrossAmount		float
totalTaxAmount	totalTaxAmount		float
tipo	type	True	string
useCollectiveContact	useCollectiveContact		boolean
voucherDate	voucherDate		date
quantidade	amount		float
categoryId	categoryId		string
taxAmount	taxAmount		float
taxRatePercent	taxRatePercent		integer
voucherNumber	voucherNumber		string
voucherStatus	voucherStatus		string

Retornos

Corpo: Response_vouchers_post

Criar uma confirmação de pedido

ID da operação:: CreateOrderConfirmation

Esse ponto de extremidade fornece acesso de leitura e gravação a confirmações de pedidos e também a possibilidade de renderizar o documento como UM PDF para baixá-lo. As confirmações de pedido são sempre criadas no modo de rascunho e não precisam ser finalizadas.

Parâmetros

Nome	Chave	Obrigatório	Tipo	Description
ID do voucher de vendas anterior	precedingSalesVoucherId		string	Especifique a ID do voucher de vendas anterior.

Retornos

Corpo: Response_order-confirmations_post

Criar uma cotação

ID da operação:: CreateQuotation

As aspas transmitidas por meio da API são criadas no modo de rascunho por padrão. Para criar uma aspa finalizada com o status, abra a finalização do parâmetro de consulta opcional. O status de uma aspa não pode ser alterado por meio da api.

Parâmetros

Nome	Chave	Obrigatório	Tipo	Description
Ultimar	finalize	True	boolean	Especifique a finalização.

Retornos

Corpo: Response_quotations_post

Criar uma fatura

ID da operação:: CreateInvoice

As faturas transmitidas por meio da API são criadas no modo de rascunho por padrão. Para criar uma fatura finalizada com status, abra a finalização do parâmetro de consulta opcional. O status de uma fatura não pode ser alterado por meio da api.

Parâmetros

Nome	Chave	Obrigatório	Tipo	Description
ID do voucher de vendas anterior	precedingSalesVoucherId		string	Especifique a ID do voucher de vendas anterior.
Ultimar	finalize	True	boolean	Especifique a finalização.

Retornos

Corpo: Response_invoices_post

Criar uma nota de crédito

ID da operação:: CreateCreditNote

As notas de crédito transmitidas por meio da API são criadas no modo de rascunho por padrão. Para criar uma nota de crédito finalizada com status, abra a finalização do parâmetro de consulta opcional. O status de uma nota de crédito não pode ser alterado por meio da api

Parâmetros

Nome	Chave	Obrigatório	Tipo	Description
ID do voucher de vendas anterior	precedingSalesVoucherId		string	Especifique a ID do voucher de vendas anterior.
Ultimar	finalize	True	boolean	Especifique a finalização.

Retornos

Corpo: Response_credit-notes_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 por meio da API são criadas somente no modo de rascunho.

Parâmetros

Nome	Chave	Obrigatório	Tipo	Description
ID do voucher de vendas anterior	precedingSalesVoucherId		string	Especifique a ID do voucher de vendas anterior.

Retornos

Corpo: Response_delivery-notes_post

Excluir um artigo

ID da operação:: DeleteAnArticle

Exclui o artigo com o valor da ID {id}. Retorna 204 com êxito ou 404 se a ID não existir.

Parâmetros

Nome	Chave	Obrigatório	Tipo	Description
ID	id	True	string	Especifique a ID.

Excluir um Event-Subscription

ID da operação:: DeleteEventSubscription

Excluir WebHook de Gatilho

Parâmetros

Nome	Chave	Obrigatório	Tipo	Description
ID da assinatura	subscriptionId	True	string	Especifique a ID da assinatura.

Filtrando artigos

ID da operação:: FilteringArticles

Retorna os artigos que atendem aos critérios dados por filtros filter_1 para filter_n usando um mecanismo de paginação. Se mais de um filtro for dado, o conector lógico será AND. Os filtros que não estão definidos são ignorados. Para verificar o tamanho máximo da página para esse ponto de extremidade, consulte Paginação de Recursos.

Parâmetros

Nome	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.
Classificar	sort	string	Especifique a classificação.

Retornos

Corpo: Response_articles_get

Recuperar e filtrar a lista de vouchers

ID da operação:: RetrieveAndFilterVoucherlist

Obtenha vouchers (contabilidade) (por exemplo, salesinvoices, salescreditnotes), faturas (incluindo faturas de pagamento inativo), notas de crédito, confirmações de pedidos, aspas e notas de entrega.

Parâmetros

Nome	Chave	Obrigatório	Tipo	Description
Tipo de voucher	voucherType	True	string	Especifique o tipo de voucher.
Voucher Status	voucherStatus	True	string	Especifique o status do voucher.
Arquivados	archived		boolean	Especifique o arquivo arquivado.
ID de contato	contactId		string	Especifique a ID do contato.
Data do voucher de	voucherDateFrom		string	Especifique a data do voucher.
Data do voucher para	voucherDateTo		string	Especifique a data do voucher para.
Data criada 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 atualizada de	updatedDateFrom		string	Especifique a data atualizada.
Data atualizada para	updatedDateTo		string	Especifique a data atualizada 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.
Classificar	sort		string	Especifique a classificação.

Retornos

Corpo: Response_voucherlist_get

Recuperar informações de pagamento

ID da operação:: RetrievePaymentInformation

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

Parâmetros

Nome	Chave	Obrigatório	Tipo	Description
Voucher Id	voucherId	True	string	Especifique a ID do voucher.

Retornos

Nome	Caminho	Tipo
moeda	currency	string
openAmount	openAmount	string
paymentItems	paymentItems	array of object
quantidade	paymentItems.amount	float
moeda	paymentItems.currency	string
paymentItemType	paymentItems.paymentItemType	string
postDate	paymentItems.postingDate	date-time
paymentStatus	paymentStatus	string
voucherStatus	voucherStatus	string
voucherType	voucherType	string

Recuperar informações de perfil

ID da operação:: RetrieveProfileInformation

O exemplo a seguir mostra como recuperar suas informações básicas de perfil. É necessário substituir o espaço reservado {accessToken} antes de enviar a solicitação.

Retornos

Corpo: Response_profile_get

Recuperar lista de condições de pagamento

ID da operação:: RetrieveListOfPaymentConditions

O exemplo a seguir mostra como recuperar a lista de condições de pagamento atualmente configuradas. É necessário substituir o espaço reservado {accessToken} antes de enviar a solicitação.

Retornos

response: array of Response_payment-conditions_get_items

Recuperar lista de países

ID da operação:: RetrieveListCountries

Lista de países conhecidos por lexoffice.

Retornos

response: array of Response_countries_get_default

Recuperar todas as assinaturas de evento

ID da operação:: RetrieveAllEventSubscriptions

Recuperar todas as assinaturas de evento

Retornos

Corpo: Response_event-subscriptions_get

Recuperar todos os contatos

ID da operação:: RetrieveAllContacts

Recuperar todos os contatos

Parâmetros

Nome	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.
Customer	customer	boolean	Especifique o cliente.
Página	page	integer	Especifique a página.
Tamanho	size	integer	Especifique o tamanho.
Classificar	sort	string	Especifique a classificação.

Retornos

Corpo: Response_contacts_get

Recuperar todos os modelos recorrentes

ID da operação:: RetrieveAllRecurringTemplates

Recupere uma coleção de modelos recorrentes. O resultado retorna apenas parte dos dados mais relevantes que são o contato referenciado (apenas id e nome), preço total, condições de pagamento e as configurações completas de modelos recorrentes. No entanto, a nomenclatura de objetos e propriedades é a mesma.

Parâmetros

Nome	Chave	Tipo	Description
Página	page	integer	Especifique a página.
Tamanho	size	integer	Especifique o tamanho.
Classificar	sort	string	Especifique a classificação.

Retornos

Corpo: Response_recurring-templates_get

Recuperar um artigo

ID da operação:: RetrieveAnArticle

Retorna o artigo com o valor da ID {id}.

Parâmetros

Nome	Chave	Obrigatório	Tipo	Description
ID	id	True	string	Especifique a ID.

Retornos

Nome	Caminho	Tipo
articleNumber	articleNumber	string
gtin	gtin	string
id	id	string
nota	note	string
grossPrice	price.grossPrice	float
leadingPrice	price.leadingPrice	string
netPrice	price.netPrice	float
taxa de impostos	price.taxRate	float
title	title	string
tipo	type	string
unitName	unitName	string
versão	version	integer

Recuperar um contato

ID da operação:: RetrieveContact

Recuperar um contato por ID

Parâmetros

Nome	Chave	Obrigatório	Tipo	Description
ID	id	True	string	Especifique a ID.

Retornos

Nome	Caminho	Tipo
Arquivados	archived	boolean
id	id	string
organizationId	organizationId	string
primeiro nome	person.firstName	string
sobrenome	person.lastName	string
saudação	person.salutation	string
número	roles.customer.number	integer
versão	version	integer

Recuperar um dunning

ID da operação:: RetrieveDunning

Retorna o dunning com o valor de ID {id}.

Parâmetros

Nome	Chave	Obrigatório	Tipo	Description
Dunningsid	dunningsid	True	string	Especifique o dunningsid.

Retornos

Nome	Caminho	Tipo
city	address.city	string
countryCode	address.countryCode	string
nome	address.name	string
rua	address.street	string
Suplemento	address.supplement	string
zip	address.zip	string
Arquivados	archived	boolean
createdDate	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
unitName	lineItems.unitName	string
moeda	lineItems.unitPrice.currency	string
grossAmount	lineItems.unitPrice.grossAmount	number
netAmount	lineItems.unitPrice.netAmount	number
taxRatePercentage	lineItems.unitPrice.taxRatePercentage	number
organizationId	organizationId	uuid
relatedVouchers	relatedVouchers	array of object
id	relatedVouchers.id	uuid
voucherNumber	relatedVouchers.voucherNumber	string
voucherType	relatedVouchers.voucherType	string
comentário	remark	string
shippingDate	shippingConditions.shippingDate	date-time
shippingType	shippingConditions.shippingType	string
taxAmounts	taxAmounts	array of object
netAmount	taxAmounts.netAmount	number
taxAmount	taxAmounts.taxAmount	number
taxRatePercentage	taxAmounts.taxRatePercentage	number
taxType	taxConditions.taxType	string
title	title	string
moeda	totalPrice.currency	string
totalGrossAmount	totalPrice.totalGrossAmount	number
totalNetAmount	totalPrice.totalNetAmount	number
totalTaxAmount	totalPrice.totalTaxAmount	number
updatedDate	updatedDate	date-time
versão	version	integer
voucherDate	voucherDate	date-time
voucherStatus	voucherStatus	string

Recuperar um modelo recorrente

ID da operação:: RetrieveRecurringTemplate

Retorna o modelo recorrente com o valor da ID {id}.

Parâmetros

Nome	Chave	Obrigatório	Tipo	Description
ID	id	True	string	Especifique a ID.

Retornos

Nome	Caminho	Tipo
city	address.city	string
contactId	address.contactId	uuid
countryCode	address.countryCode	string
nome	address.name	string
rua	address.street	string
zip	address.zip	string
Arquivados	archived	boolean
createdDate	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
unitName	lineItems.unitName	string
moeda	lineItems.unitPrice.currency	string
grossAmount	lineItems.unitPrice.grossAmount	number
netAmount	lineItems.unitPrice.netAmount	number
taxRatePercentage	lineItems.unitPrice.taxRatePercentage	number
organizationId	organizationId	uuid
paymentTermDuration	paymentConditions.paymentTermDuration	integer
paymentTermLabel	paymentConditions.paymentTermLabel	string
paymentTermLabelTemplate	paymentConditions.paymentTermLabelTemplate	string
recurringTemplateSettings	recurringTemplateSettings	object
comentário	remark	string
taxAmounts	taxAmounts	array of object
netAmount	taxAmounts.netAmount	number
taxAmount	taxAmounts.taxAmount	number
taxRatePercentage	taxAmounts.taxRatePercentage	number
taxType	taxConditions.taxType	string
title	title	string
moeda	totalPrice.currency	string
totalGrossAmount	totalPrice.totalGrossAmount	number
totalNetAmount	totalPrice.totalNetAmount	number
totalTaxAmount	totalPrice.totalTaxAmount	number
updatedDate	updatedDate	date-time
versão	version	integer

Recuperar um voucher

ID da operação:: RetrieveVoucher

Listar vouchers de vendas (por exemplo, faturas, notas de crédito)

Parâmetros

Nome	Chave	Obrigatório	Tipo	Description
ID	id	True	string	Especifique a ID.

Retornos

Nome	Caminho	Tipo
createdDate	createdDate	date-time
dueDate	dueDate	date-time
arquivos	files	array of string
id	id	uuid
organizationId	organizationId	uuid
comentário	remark	string
shippingDate	shippingDate	date-time
taxType	taxType	string
totalGrossAmount	totalGrossAmount	number
totalTaxAmount	totalTaxAmount	number
tipo	type	string
updatedDate	updatedDate	date-time
useCollectiveContact	useCollectiveContact	boolean
versão	version	integer
voucherDate	voucherDate	date-time
voucherItems	voucherItems	array of object
quantidade	voucherItems.amount	number
categoryId	voucherItems.categoryId	uuid
taxAmount	voucherItems.taxAmount	number
taxRatePercent	voucherItems.taxRatePercent	number
voucherNumber	voucherNumber	string
voucherStatus	voucherStatus	string

Recuperar uma assinatura de evento

ID da operação:: RetrieveAEventSubscription

Recuperar uma assinatura de evento

Parâmetros

Nome	Chave	Obrigatório	Tipo	Description
ID da assinatura	subscriptionId	True	string	Especifique a ID da assinatura.

Retornos

Corpo: EventSubscriptionResponse

Recuperar uma confirmação de pedido

ID da operação:: RetrieveOrderConfirmation

Retorna a confirmação do pedido com o valor da ID {id}.

Parâmetros

Nome	Chave	Obrigatório	Tipo	Description
ID	id	True	string	Especifique a ID.

Retornos

Nome	Caminho	Tipo
city	address.city	string
countryCode	address.countryCode	string
nome	address.name	string
rua	address.street	string
Suplemento	address.supplement	string
zip	address.zip	string
Arquivados	archived	boolean
createdDate	createdDate	date-time
deliveryTerms	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
unitName	lineItems.unitName	string
moeda	lineItems.unitPrice.currency	string
grossAmount	lineItems.unitPrice.grossAmount	number
netAmount	lineItems.unitPrice.netAmount	number
taxRatePercentage	lineItems.unitPrice.taxRatePercentage	number
organizationId	organizationId	uuid
discountPercentage	paymentConditions.paymentDiscountConditions.discountPercentage	number
discountRange	paymentConditions.paymentDiscountConditions.discountRange	integer
paymentTermDuration	paymentConditions.paymentTermDuration	integer
paymentTermLabel	paymentConditions.paymentTermLabel	string
paymentTermLabelTemplate	paymentConditions.paymentTermLabelTemplate	string
comentário	remark	string
shippingDate	shippingConditions.shippingDate	date-time
shippingType	shippingConditions.shippingType	string
taxAmounts	taxAmounts	array of object
netAmount	taxAmounts.netAmount	number
taxAmount	taxAmounts.taxAmount	number
taxRatePercentage	taxAmounts.taxRatePercentage	number
taxType	taxConditions.taxType	string
title	title	string
moeda	totalPrice.currency	string
totalGrossAmount	totalPrice.totalGrossAmount	number
totalNetAmount	totalPrice.totalNetAmount	number
totalTaxAmount	totalPrice.totalTaxAmount	number
updatedDate	updatedDate	date-time
versão	version	integer
voucherDate	voucherDate	date-time
voucherNumber	voucherNumber	string
voucherStatus	voucherStatus	string

Recuperar uma cotação

ID da operação:: RetrieveQuotation

Retorna a aspas com o valor da ID {id}. Renderizar um documento de aspas (PDF)

Parâmetros

Nome	Chave	Obrigatório	Tipo	Description
ID	id	True	string	Especifique a ID.

Retornos

Nome	Caminho	Tipo
city	address.city	string
contactId	address.contactId	uuid
countryCode	address.countryCode	string
nome	address.name	string
rua	address.street	string
zip	address.zip	string
Arquivados	archived	boolean
createdDate	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
opcional	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
opcional	lineItems.subItems.optional	boolean
quantidade	lineItems.subItems.quantity	number
tipo	lineItems.subItems.type	string
unitName	lineItems.subItems.unitName	string
moeda	lineItems.subItems.unitPrice.currency	string
grossAmount	lineItems.subItems.unitPrice.grossAmount	number
netAmount	lineItems.subItems.unitPrice.netAmount	number
taxRatePercentage	lineItems.subItems.unitPrice.taxRatePercentage	number
tipo	lineItems.type	string
unitName	lineItems.unitName	string
moeda	lineItems.unitPrice.currency	string
grossAmount	lineItems.unitPrice.grossAmount	number
netAmount	lineItems.unitPrice.netAmount	number
taxRatePercentage	lineItems.unitPrice.taxRatePercentage	number
organizationId	organizationId	uuid
discountPercentage	paymentConditions.paymentDiscountConditions.discountPercentage	number
discountRange	paymentConditions.paymentDiscountConditions.discountRange	integer
paymentTermDuration	paymentConditions.paymentTermDuration	integer
paymentTermLabel	paymentConditions.paymentTermLabel	string
paymentTermLabelTemplate	paymentConditions.paymentTermLabelTemplate	string
comentário	remark	string
taxAmounts	taxAmounts	array of object
netAmount	taxAmounts.netAmount	number
taxAmount	taxAmounts.taxAmount	number
taxRatePercentage	taxAmounts.taxRatePercentage	number
taxType	taxConditions.taxType	string
title	title	string
moeda	totalPrice.currency	string
totalGrossAmount	totalPrice.totalGrossAmount	number
totalNetAmount	totalPrice.totalNetAmount	number
totalTaxAmount	totalPrice.totalTaxAmount	number
updatedDate	updatedDate	date-time
versão	version	integer
voucherDate	voucherDate	date-time
voucherNumber	voucherNumber	string
voucherStatus	voucherStatus	string

Recuperar uma fatura

ID da operação:: RetrieveInvoice

Retorna a fatura com o valor da ID {id}.

Parâmetros

Nome	Chave	Obrigatório	Tipo	Description
ID	id	True	string	Especifique a ID.

Retornos

Nome	Caminho	Tipo
city	address.city	string
countryCode	address.countryCode	string
nome	address.name	string
rua	address.street	string
Suplemento	address.supplement	string
zip	address.zip	string
Arquivados	archived	boolean
createdDate	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
unitName	lineItems.unitName	string
moeda	lineItems.unitPrice.currency	string
grossAmount	lineItems.unitPrice.grossAmount	number
netAmount	lineItems.unitPrice.netAmount	number
taxRatePercentage	lineItems.unitPrice.taxRatePercentage	number
organizationId	organizationId	uuid
discountPercentage	paymentConditions.paymentDiscountConditions.discountPercentage	number
discountRange	paymentConditions.paymentDiscountConditions.discountRange	integer
paymentTermDuration	paymentConditions.paymentTermDuration	integer
paymentTermLabel	paymentConditions.paymentTermLabel	string
paymentTermLabelTemplate	paymentConditions.paymentTermLabelTemplate	string
comentário	remark	string
shippingDate	shippingConditions.shippingDate	date-time
shippingType	shippingConditions.shippingType	string
taxAmounts	taxAmounts	array of object
netAmount	taxAmounts.netAmount	number
taxAmount	taxAmounts.taxAmount	number
taxRatePercentage	taxAmounts.taxRatePercentage	number
taxType	taxConditions.taxType	string
title	title	string
moeda	totalPrice.currency	string
totalGrossAmount	totalPrice.totalGrossAmount	number
totalNetAmount	totalPrice.totalNetAmount	number
totalTaxAmount	totalPrice.totalTaxAmount	number
updatedDate	updatedDate	date-time
versão	version	integer
voucherDate	voucherDate	date-time
voucherNumber	voucherNumber	string
voucherStatus	voucherStatus	string

Recuperar uma fatura de pagamento inoperante

ID da operação:: RetrieveDownPaymentInvoice

Retorna a fatura de pagamento inativo com o valor da ID {id}.

Parâmetros

Nome	Chave	Obrigatório	Tipo	Description
ID	id	True	string	Especifique a ID.

Retornos

Nome	Caminho	Tipo
city	address.city	string
countryCode	address.countryCode	string
nome	address.name	string
rua	address.street	string
Suplemento	address.supplement	string
zip	address.zip	string
Arquivados	archived	boolean
closingInvoiceId	closingInvoiceId	uuid
createdDate	createdDate	date-time
dueDate	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
grossAmount	lineItems.unitPrice.grossAmount	number
netAmount	lineItems.unitPrice.netAmount	number
taxRatePercentage	lineItems.unitPrice.taxRatePercentage	number
organizationId	organizationId	uuid
discountPercentage	paymentConditions.paymentDiscountConditions.discountPercentage	number
discountRange	paymentConditions.paymentDiscountConditions.discountRange	integer
paymentTermDuration	paymentConditions.paymentTermDuration	integer
paymentTermLabel	paymentConditions.paymentTermLabel	string
paymentTermLabelTemplate	paymentConditions.paymentTermLabelTemplate	string
comentário	remark	string
shippingType	shippingConditions.shippingType	string
taxAmounts	taxAmounts	array of object
netAmount	taxAmounts.netAmount	number
taxAmount	taxAmounts.taxAmount	number
taxRatePercentage	taxAmounts.taxRatePercentage	number
taxType	taxConditions.taxType	string
title	title	string
moeda	totalPrice.currency	string
totalGrossAmount	totalPrice.totalGrossAmount	number
totalNetAmount	totalPrice.totalNetAmount	number
totalTaxAmount	totalPrice.totalTaxAmount	number
updatedDate	updatedDate	date-time
versão	version	integer
voucherDate	voucherDate	date-time
voucherNumber	voucherNumber	string
voucherStatus	voucherStatus	string

Recuperar uma lista de categorias de postagem

ID da operação:: RetrieveListPostingCategories

Esse ponto de extremidade fornece acesso de leitura à lista de categorias de postagem para a receita ou despesa de vouchers (contabilidade) com suporte no lexoffice.

Retornos

response: array of Response_posting-categories_get_items

Recuperar uma nota de crédito

ID da operação:: RetrieveCreditNote

Esse ponto de extremidade fornece acesso de leitura e gravação a notas de crédito e também a possibilidade de renderizar o documento como um PDF para baixá-lo. As notas de crédito podem ser criadas como um rascunho ou finalizadas no modo aberto.

Parâmetros

Nome	Chave	Obrigatório	Tipo	Description
ID	id	True	string	Especifique a ID.

Retornos

Nome	Caminho	Tipo
city	address.city	string
countryCode	address.countryCode	string
nome	address.name	string
rua	address.street	string
Suplemento	address.supplement	string
zip	address.zip	string
Arquivados	archived	boolean
createdDate	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
unitName	lineItems.unitName	string
moeda	lineItems.unitPrice.currency	string
grossAmount	lineItems.unitPrice.grossAmount	float
netAmount	lineItems.unitPrice.netAmount	float
taxRatePercentage	lineItems.unitPrice.taxRatePercentage	number
organizationId	organizationId	uuid
comentário	remark	string
taxAmounts	taxAmounts	array of object
netAmount	taxAmounts.netAmount	number
taxAmount	taxAmounts.taxAmount	number
taxRatePercentage	taxAmounts.taxRatePercentage	number
taxType	taxConditions.taxType	string
title	title	string
moeda	totalPrice.currency	string
totalGrossAmount	totalPrice.totalGrossAmount	float
totalNetAmount	totalPrice.totalNetAmount	float
totalTaxAmount	totalPrice.totalTaxAmount	float
updatedDate	updatedDate	date-time
versão	version	integer
voucherDate	voucherDate	date-time
voucherNumber	voucherNumber	string
voucherStatus	voucherStatus	string

Recuperar uma nota de entrega

ID da operação:: RetrieveDeliveryNote

Retorna a nota de entrega com o valor da ID {id}.

Parâmetros

Nome	Chave	Obrigatório	Tipo	Description
ID	id	True	string	Especifique a ID.

Retornos

Nome	Caminho	Tipo
city	address.city	string
countryCode	address.countryCode	string
nome	address.name	string
rua	address.street	string
Suplemento	address.supplement	string
zip	address.zip	string
Arquivados	archived	boolean
createdDate	createdDate	date-time
deliveryTerms	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
unitName	lineItems.unitName	string
moeda	lineItems.unitPrice.currency	string
grossAmount	lineItems.unitPrice.grossAmount	number
netAmount	lineItems.unitPrice.netAmount	number
taxRatePercentage	lineItems.unitPrice.taxRatePercentage	number
organizationId	organizationId	uuid
comentário	remark	string
taxType	taxConditions.taxType	string
title	title	string
updatedDate	updatedDate	date-time
versão	version	integer
voucherDate	voucherDate	date-time
voucherNumber	voucherNumber	string
voucherStatus	voucherStatus	string

Renderizar um documento de anotação de crédito (PDF)

ID da operação:: RenderCreditNoteDocument

Para baixar o arquivo pdf de um documento de anotação de crédito, você precisa de seu documentFileId. Essa ID geralmente é retornada pelo recurso de anotação de crédito. No entanto, as notas de crédito recém-criadas no status aberto por meio da API precisam disparar o arquivo de documento pdf renderizando separadamente. Isso pode ser feito com esse ponto de extremidade.

Parâmetros

Nome	Chave	Obrigatório	Tipo	Description
ID	id	True	string	Especifique a ID.

Retornos

Nome	Caminho	Tipo	Description
documentFileId	documentFileId	uuid

Renderizar um documento de aspas (PDF)

ID da operação:: RenderQuotationDocument

Para baixar o arquivo pdf de um documento de aspas, você precisa de seu documentFileId. Essa ID geralmente é retornada pelo recurso de aspas. No entanto, as aspas recém-criadas no status aberto por meio da API precisam disparar a renderização separada do arquivo de documento pdf. Isso pode ser feito com esse ponto de extremidade.

Parâmetros

Nome	Chave	Obrigatório	Tipo	Description
ID	id	True	string	Especifique a ID.

Retornos

Nome	Caminho	Tipo	Description
documentFileId	documentFileId	uuid

Renderizar um documento de confirmação de pedido (PDF)

ID da operação:: RenderOrderConfirmationDocument

Para baixar o arquivo pdf de um documento de confirmação de pedido, você precisa de seu documentFileId. Essa ID geralmente é retornada pelo recurso de confirmação do pedido. No entanto, as confirmações de pedido recém-criadas por meio da API precisam disparar a renderização separada do arquivo de documento pdf. Isso pode ser feito com esse ponto de extremidade.

Parâmetros

Nome	Chave	Obrigatório	Tipo	Description
ID	id	True	string	Especifique a ID.

Retornos

Nome	Caminho	Tipo	Description
documentFileId	documentFileId	uuid

Renderizar um documento de fatura (PDF)

ID da operação:: RenderInvoiceDocument

Para baixar o arquivo pdf de um documento de fatura, você precisa de seu documentFileId. Essa ID geralmente é retornada pelo recurso da fatura. No entanto, as faturas recém-criadas no status aberto por meio da API precisam disparar o arquivo de documento pdf renderizando separadamente. Isso pode ser feito com esse ponto de extremidade.

Parâmetros

Nome	Chave	Obrigatório	Tipo	Description
ID	id	True	string	Especifique a ID.

Retornos

Nome	Caminho	Tipo	Description
documentFileId	documentFileId	uuid

Renderizar um documento de nota de entrega (PDF)

ID da operação:: RenderDeliveryNoteDocument

Esse ponto de extremidade fornece acesso de leitura e gravação a notas de entrega e também a possibilidade de renderizar o documento como um PDF para baixá-lo. As notas de entrega são sempre criadas no modo de rascunho e não precisam ser finalizadas.

Parâmetros

Nome	Chave	Obrigatório	Tipo	Description
Entrega Em 2018	DeliveryNoteid	True	string	Especifique o certificado de entrega.

Retornos

Nome	Caminho	Tipo
city	address.city	string
countryCode	address.countryCode	string
nome	address.name	string
rua	address.street	string
Suplemento	address.supplement	string
zip	address.zip	string
Arquivados	archived	boolean
createdDate	createdDate	date-time
deliveryTerms	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
unitName	lineItems.unitName	string
moeda	lineItems.unitPrice.currency	string
grossAmount	lineItems.unitPrice.grossAmount	float
netAmount	lineItems.unitPrice.netAmount	float
taxRatePercentage	lineItems.unitPrice.taxRatePercentage	number
organizationId	organizationId	uuid
comentário	remark	string
taxType	taxConditions.taxType	string
title	title	string
updatedDate	updatedDate	date-time
versão	version	integer
voucherDate	voucherDate	date-time
voucherNumber	voucherNumber	string
voucherStatus	voucherStatus	string

Renderizar um documento de não-identificação (PDF)

ID da operação:: RenderDunningDocument

Para baixar o arquivo pdf de um documento de não conformidade, você precisa de seu documentFileId. Essa ID geralmente é retornada pelo recurso de não-identificação. No entanto, os dunnings recém-criados por meio da API precisam disparar a renderização separada do arquivo de documento pdf. Isso pode ser feito com esse ponto de extremidade.

Parâmetros

Nome	Chave	Obrigatório	Tipo	Description
Dunningsid	dunningsid	True	string	Especifique o dunningsid.

Retornos

Nome	Caminho	Tipo	Description
documentFileId	documentFileId	uuid

Gatilhos

Selecione o gatilho personalizado

Registrar um novo gatilho para o ponto de extremidade de contatos

Selecione o gatilho personalizado

ID da operação:: EventSubscription_Lexoffice

Registrar um novo gatilho para o ponto de extremidade de contatos

Parâmetros

Nome	Chave	Obrigatório	Tipo	Description
Tipo de evento	eventType	True	string	eventType

Retornos

Nome	Caminho	Tipo	Description
eventDate	eventDate	string	eventDate
eventType	eventType	string	eventType
organizationId	organizationId	string	organizationId
resourceId	resourceId	string	resourceId

Definições

EventSubscriptionResponse

Nome	Caminho	Tipo
subscriptionId	subscriptionId	string
eventType	eventType	string
organizationId	organizationId	string
createdDate	createdDate	date-time
callbackUrl	callbackUrl	string

Response_articles_get

Nome	Caminho	Tipo	Description
conteúdo	content	array of object	conteúdo
articleNumber	content.articleNumber	string	articleNumber
gtin	content.gtin	string	gtin
id	content.id	string	id
nota	content.note	string	nota
grossPrice	content.price.grossPrice	float	grossPrice
leadingPrice	content.price.leadingPrice	string	leadingPrice
netPrice	content.price.netPrice	float	netPrice
taxa de impostos	content.price.taxRate	float	taxa de impostos
title	content.title	string	title
tipo	content.type	string	tipo
unitName	content.unitName	string	unitName
versão	content.version	integer	versão
primeiro	first	boolean	primeiro
último	last	boolean	último
número	number	integer	número
numberOfElements	numberOfElements	integer	numberOfElements
size	size	integer	size
classificar	sort	array of object	classificar
ascendente	sort.ascending	boolean	ascendente
direção	sort.direction	string	direção
ignoreCase	sort.ignoreCase	boolean	ignoreCase
nullHandling	sort.nullHandling	string	nullHandling
propriedade	sort.property	string	propriedade
totalElements	totalElements	integer	totalElements
totalPages	totalPages	integer	totalPages

Response_articles_id_get

Nome	Caminho	Tipo	Description
articleNumber	articleNumber	string	articleNumber
gtin	gtin	string	gtin
id	id	string	id
nota	note	string	nota
grossPrice	price.grossPrice	float	grossPrice
leadingPrice	price.leadingPrice	string	leadingPrice
netPrice	price.netPrice	float	netPrice
taxa de impostos	price.taxRate	float	taxa de impostos
title	title	string	title
tipo	type	string	tipo
unitName	unitName	string	unitName
versão	version	integer	versão

Response_articles_post

Nome	Caminho	Tipo	Description
createdDate	createdDate	string	createdDate
id	id	string	id
resourceUri	resourceUri	string	resourceUri
updatedDate	updatedDate	string	updatedDate
versão	version	integer	versão

Response_contacts_get

Nome	Caminho	Tipo	Description
conteúdo	content	array of object	conteúdo
cobrança	content.addresses.billing	array of object	cobrança
city	content.addresses.billing.city	string	city
countryCode	content.addresses.billing.countryCode	string	countryCode
rua	content.addresses.billing.street	string	rua
Suplemento	content.addresses.billing.supplement	string	Suplemento
zip	content.addresses.billing.zip	string	zip
transporte	content.addresses.shipping	array of object	transporte
city	content.addresses.shipping.city	string	city
countryCode	content.addresses.shipping.countryCode	string	countryCode
rua	content.addresses.shipping.street	string	rua
Suplemento	content.addresses.shipping.supplement	string	Suplemento
zip	content.addresses.shipping.zip	string	zip
Arquivados	content.archived	boolean	Arquivados
allowTaxFreeInvoices	content.company.allowTaxFreeInvoices	boolean	allowTaxFreeInvoices
contactPersons	content.company.contactPersons	array of object	contactPersons
endereço de email	content.company.contactPersons.emailAddress	string	endereço de email
primeiro nome	content.company.contactPersons.firstName	string	primeiro nome
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
taxNumber	content.company.taxNumber	string	taxNumber
vatRegistrationId	content.company.vatRegistrationId	string	vatRegistrationId
empresa	content.emailAddresses.business	array of string	empresa
escritório	content.emailAddresses.office	array of string	escritório
outro	content.emailAddresses.other	array of string	outro
id	content.id	string	id
nota	content.note	string	nota
organizationId	content.organizationId	string	organizationId
empresa	content.phoneNumbers.business	array of string	empresa
fax	content.phoneNumbers.fax	array of string	fax
escritório	content.phoneNumbers.office	array of string	escritório
outro	content.phoneNumbers.other	array of string	outro
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
numberOfElements	numberOfElements	integer	numberOfElements
size	size	integer	size
classificar	sort	array of object	classificar
ascendente	sort.ascending	boolean	ascendente
direção	sort.direction	string	direção
ignoreCase	sort.ignoreCase	boolean	ignoreCase
nullHandling	sort.nullHandling	string	nullHandling
propriedade	sort.property	string	propriedade
totalElements	totalElements	integer	totalElements
totalPages	totalPages	integer	totalPages

Response_contacts_post

Nome	Caminho	Tipo	Description
createdDate	createdDate	string	createdDate
id	id	string	id
resourceUri	resourceUri	string	resourceUri
updatedDate	updatedDate	string	updatedDate
versão	version	integer	versão

Response_countries_get_default

Nome	Caminho	Tipo	Description
countryCode	countryCode	string	countryCode
countryNameDE	countryNameDE	string	countryNameDE
countryNameEN	countryNameEN	string	countryNameEN
taxClassification	taxClassification	string	taxClassification

Response_credit-notes_post

Nome	Caminho	Tipo	Description
createdDate	createdDate	string	createdDate
id	id	string	id
resourceUri	resourceUri	string	resourceUri
updatedDate	updatedDate	string	updatedDate
versão	version	integer	versão

Response_delivery-notes_post

Nome	Caminho	Tipo	Description
createdDate	createdDate	string	createdDate
id	id	string	id
resourceUri	resourceUri	string	resourceUri
updatedDate	updatedDate	string	updatedDate
versão	version	integer	versão

Response_dunnings_post

Nome	Caminho	Tipo	Description
createdDate	createdDate	string	createdDate
id	id	string	id
resourceUri	resourceUri	string	resourceUri
updatedDate	updatedDate	string	updatedDate
versão	version	integer	versão

Response_event-subscriptions_get

Nome	Caminho	Tipo	Description
conteúdo	content	array of object	conteúdo
callbackUrl	content.callbackUrl	string	callbackUrl
createdDate	content.createdDate	string	createdDate
eventType	content.eventType	string	eventType
organizationId	content.organizationId	string	organizationId
subscriptionId	content.subscriptionId	string	subscriptionId

Response_files_post

Nome	Caminho	Tipo	Description
id	id	string	id

Response_invoices_post

Nome	Caminho	Tipo	Description
createdDate	createdDate	string	createdDate
id	id	string	id
resourceUri	resourceUri	string	resourceUri
updatedDate	updatedDate	string	updatedDate
versão	version	integer	versão

Response_order-confirmations_post

Nome	Caminho	Tipo	Description
createdDate	createdDate	string	createdDate
id	id	string	id
resourceUri	resourceUri	string	resourceUri
updatedDate	updatedDate	string	updatedDate
versão	version	integer	versão

Response_payment-conditions_get_items

Nome	Caminho	Tipo	Description
id	id	string	id
organizationDefault	organizationDefault	boolean	organizationDefault
discountPercentage	paymentDiscountConditions.discountPercentage	integer	discountPercentage
discountRange	paymentDiscountConditions.discountRange	integer	discountRange
paymentTermDuration	paymentTermDuration	integer	paymentTermDuration
paymentTermLabelTemplate	paymentTermLabelTemplate	string	paymentTermLabelTemplate

Response_posting-categories_get_items

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

Response_profile_get

Nome	Caminho	Tipo	Description
businessFeatures	businessFeatures	array of string	businessFeatures
CompanyName	companyName	string	CompanyName
connectionId	connectionId	string	connectionId
date	created.date	string	date
userEmail	created.userEmail	string	userEmail
userId	created.userId	string	userId
userName	created.userName	string	userName
features	features	array of string	features
organizationId	organizationId	string	organizationId
Smallbusiness	smallBusiness	boolean	Smallbusiness
status de assinatura	subscriptionStatus	string	status de assinatura
taxType	taxType	string	taxType

Response_quotations_post

Nome	Caminho	Tipo	Description
createdDate	createdDate	string	createdDate
id	id	string	id
resourceUri	resourceUri	string	resourceUri
updatedDate	updatedDate	string	updatedDate
versão	version	integer	versão

Response_recurring-templates_get

Nome	Caminho	Tipo	Description
conteúdo	content	array of object	conteúdo
contactId	content.address.contactId	string	contactId
nome	content.address.name	string	nome
createdDate	content.createdDate	string	createdDate
id	content.id	string	id
organizationId	content.organizationId	string	organizationId
discountPercentage	content.paymentConditions.paymentDiscountConditions.discountPercentage	integer	discountPercentage
discountRange	content.paymentConditions.paymentDiscountConditions.discountRange	integer	discountRange
paymentTermDuration	content.paymentConditions.paymentTermDuration	integer	paymentTermDuration
paymentTermLabel	content.paymentConditions.paymentTermLabel	string	paymentTermLabel
paymentTermLabelTemplate	content.paymentConditions.paymentTermLabelTemplate	string	paymentTermLabelTemplate
data de término	content.recurringTemplateSettings.endDate	string	data de término
executionInterval	content.recurringTemplateSettings.executionInterval	string	executionInterval
Executionstatus	content.recurringTemplateSettings.executionStatus	string	Executionstatus
Finalizar	content.recurringTemplateSettings.finalize	boolean	Finalizar
id	content.recurringTemplateSettings.id	string	id
lastExecutionFailed	content.recurringTemplateSettings.lastExecutionFailed	boolean	lastExecutionFailed
nextExecutionDate	content.recurringTemplateSettings.nextExecutionDate	string	nextExecutionDate
shippingType	content.recurringTemplateSettings.shippingType	string	shippingType
startDate	content.recurringTemplateSettings.startDate	string	startDate
title	content.title	string	title
moeda	content.totalPrice.currency	string	moeda
totalGrossAmount	content.totalPrice.totalGrossAmount	integer	totalGrossAmount
totalNetAmount	content.totalPrice.totalNetAmount	float	totalNetAmount
updatedDate	content.updatedDate	string	updatedDate
primeiro	first	boolean	primeiro
último	last	boolean	último
número	number	integer	número
numberOfElements	numberOfElements	integer	numberOfElements
size	size	integer	size
classificar	sort	array of object	classificar
ascendente	sort.ascending	boolean	ascendente
direção	sort.direction	string	direção
ignoreCase	sort.ignoreCase	boolean	ignoreCase
nullHandling	sort.nullHandling	string	nullHandling
propriedade	sort.property	string	propriedade
totalElements	totalElements	integer	totalElements
totalPages	totalPages	integer	totalPages

Response_voucherlist_get

Nome	Caminho	Tipo	Description
conteúdo	content	array of object	conteúdo
Arquivados	content.archived	boolean	Arquivados
contactId	content.contactId	string	contactId
nome do contato	content.contactName	string	nome do contato
createdDate	content.createdDate	string	createdDate
moeda	content.currency	string	moeda
dueDate	content.dueDate	string	dueDate
id	content.id	string	id
openAmount	content.openAmount	float	openAmount
totalAmount	content.totalAmount	float	totalAmount
updatedDate	content.updatedDate	string	updatedDate
voucherDate	content.voucherDate	string	voucherDate
voucherNumber	content.voucherNumber	string	voucherNumber
voucherStatus	content.voucherStatus	string	voucherStatus
voucherType	content.voucherType	string	voucherType
primeiro	first	boolean	primeiro
último	last	boolean	último
número	number	integer	número
numberOfElements	numberOfElements	integer	numberOfElements
size	size	integer	size
classificar	sort	array of object	classificar
ascendente	sort.ascending	boolean	ascendente
direção	sort.direction	string	direção
ignoreCase	sort.ignoreCase	boolean	ignoreCase
nullHandling	sort.nullHandling	string	nullHandling
propriedade	sort.property	string	propriedade
totalElements	totalElements	integer	totalElements
totalPages	totalPages	integer	totalPages

Response_vouchers_post

Nome	Caminho	Tipo	Description
createdDate	createdDate	string	createdDate
id	id	string	id
resourceUri	resourceUri	string	resourceUri
updatedDate	updatedDate	string	updatedDate
versão	version	integer	versão

Response_contacts_id_put

Nome	Caminho	Tipo
Arquivados	archived	boolean
id	id	uuid
organizationId	organizationId	uuid
primeiro nome	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

Nome	Caminho	Tipo
createdDate	createdDate	date-time
dueDate	dueDate	date-time
arquivos	files	array of object
items	files	object
id	id	uuid
organizationId	organizationId	uuid
comentário	remark	string
shippingDate	shippingDate	date-time
taxType	taxType	string
totalGrossAmount	totalGrossAmount	number
totalTaxAmount	totalTaxAmount	number
tipo	type	string
updatedDate	updatedDate	date-time
useCollectiveContact	useCollectiveContact	boolean
versão	version	integer
voucherDate	voucherDate	date-time
voucherItems	voucherItems	array of object
quantidade	voucherItems.amount	number
categoryId	voucherItems.categoryId	uuid
taxAmount	voucherItems.taxAmount	number
taxRatePercent	voucherItems.taxRatePercent	number
voucherNumber	voucherNumber	string
voucherStatus	voucherStatus	string

arquivo

Esse é o tipo de dados básico 'file'.

Compartilhar via

Lexoffice (Editor Independente) (versão prévia)

Conector de API do Lexware (Editor Independente)

Publicador: Publicador Independente

Pré-requisitos

Operações com suporte

Obtendo credenciais

Gateway de API

Limites de taxa

Authentication

Exemplo de Uso

Problemas e limitações conhecidos

Documentação da API

Criando uma conexão

Padrão

Limitações

Ações

Atualizar um artigo

Parâmetros

Retornos

Atualizar um contato

Parâmetros

Retornos

Atualizar Voucher

Parâmetros

Retornos

Baixar um arquivo

Parâmetros

Retornos

Carregar um arquivo

Parâmetros

Retornos

Carregar um arquivo em um voucher

Parâmetros

Criar um artigo

Parâmetros

Retornos

Criar um contato

Retornos

Criar um dunning

Parâmetros

Retornos

Criar um voucher

Parâmetros

Retornos

Criar uma confirmação de pedido

Parâmetros

Retornos

Criar uma cotação

Parâmetros

Retornos

Criar uma fatura

Parâmetros

Retornos

Criar uma nota de crédito

Parâmetros

Retornos

Criar uma nota de entrega

Parâmetros

Retornos

Excluir um artigo

Parâmetros

Excluir um Event-Subscription

Parâmetros

Filtrando artigos

Parâmetros

Retornos

Recuperar e filtrar a lista de vouchers

Parâmetros

Retornos

Recuperar informações de pagamento

Parâmetros

Retornos

Recuperar informações de perfil

Retornos

Recuperar lista de condições de pagamento

Retornos

Recuperar lista de países

Retornos

Recuperar todas as assinaturas de evento