Lexoffice (Publicador independiente) (versión preliminar)

La API de Lexware proporciona acceso mediante programación a las principales funcionalidades empresariales de Lexware, como artículos, contactos, facturas, pedidos y administración de archivos. Este conector de Publicador independiente permite una integración segura con la API REST de Lexware, lo que permite a los usuarios crear y recuperar datos empresariales, automatizar procesos y conectar recursos de Lexware con aplicaciones de Power Platform. El conector usa OAuth 2.0 Authorization Code Flow para obtener instrucciones de API y autenticación segura.

Este conector está disponible en los siguientes productos y regiones:

Service	Class	Regions
Copilot Studio	Premium	Todas las regiones de Power Automate excepto las siguientes: - Gobierno de EE. UU. (GCC) - Gobierno de EE. UU. (GCC High) - China Cloud operado por 21Vianet - Departamento de Defensa de EE. UU. (DoD)
Aplicaciones lógicas	Estándar	Todas las regiones de Logic Apps excepto las siguientes: - Regiones de Azure Government - Regiones de Azure China - Departamento de Defensa de EE. UU. (DoD)
Power Apps	Premium	Todas las regiones de Power Apps excepto las siguientes: - Gobierno de EE. UU. (GCC) - Gobierno de EE. UU. (GCC High) - China Cloud operado por 21Vianet - Departamento de Defensa de EE. UU. (DoD)
Power Automate	Premium	Todas las regiones de Power Automate excepto las siguientes: - Gobierno de EE. UU. (GCC) - Gobierno de EE. UU. (GCC High) - China Cloud operado por 21Vianet - Departamento de Defensa de EE. UU. (DoD)

Contacto
Nombre	Compatibilidad con los investigadores de LowCode
URL	https://lowcode-investigator.com/
Correo Electrónico	kontakt@lowcodeinvestigator.com

Metadatos del conector
Publicador	LowCodeInvestigator
Sitio web	https://office.lexware.de/
Directiva de privacidad	https://office.lexware.de/datenschutz/
Categorías	Gestión empresarial; Finanzas

Conector de la API de Lexware (publicador independiente)

Lexware API es una interfaz RESTful que permite a los desarrolladores integrar funciones empresariales de Lexware, como contactos, facturas, artículos y archivos en sus propias aplicaciones. Este conector permite la interacción directa con estos recursos a través de solicitudes de API autenticadas seguras.

Publicador: publicador independiente

Prerrequisitos

Una cuenta de Lexware registrada y una licencia adecuada
Una clave de API válida (token de acceso) obtenida a través del Portal para desarrolladores de Lexware
El flujo de código de autorización de OAuth 2.0 es necesario para la autenticación

Operaciones admitidas

Este conector admite los siguientes puntos de conexión de la API de Lexware:

Artículos: Crear, recuperar, actualizar, eliminar y filtrar artículos
Contactos: Administrar datos de cliente y proveedor
Facturas: crear y recuperar datos de factura, incluidos archivos PDF de representación
Notas de crédito, notas de entrega, pedidos, presupuestos y cupones
Países, condiciones de pago, diseños de impresión y perfiles
Suscripciones y archivos de eventos
Lista completa documentada en: Documentos de la API de Lexware

Obtención de credenciales

Para llamar a Lexware API, necesita una clave de API:

Inicie sesión en su cuenta de Lexware Office.
Vaya a Extensiones → Aplicaciones weitere → API pública o abra
Portal para desarrolladores de Lexware directamente.
Cree una nueva clave de API con los permisos deseados.
Copie la clave de API generada. Este valor se usará como accessToken en el conector.

Puerta de enlace de API

Use la nueva puerta de enlace de Lexware API:

https://api.lexware.io

Límites de velocidad

Número máximo de 2 solicitudes por segundo
Las solicitudes que superan este límite reciben HTTP 429 Too Many Requests
Recomendado: Uso del algoritmo de cubo de tokens o retroceso exponencial

Autenticación

La API de Lexware usa OAuth 2.0 Authorization Code Flow. Incluya el token en el Authorization: Bearer {accessToken} encabezado de cada solicitud.

Ejemplo de uso

Creación de un artículo:

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 conocidos y limitaciones

Número máximo de 2 solicitudes por segundo
Algunos puntos de conexión requieren permisos o roles adicionales

Documentación de la API

La referencia de API completa está disponible en:
https://developers.lexware.io/docs/

Creando una conexión

El conector admite los siguientes tipos de autenticación:


Predeterminado	Parámetros para crear una conexión.	Todas las regiones	No compartible

Predeterminado

Aplicable: Todas las regiones

Parámetros para crear una conexión.

Esta conexión no se puede compartir. Si la aplicación Power se comparte con otro usuario, se le solicitará a otro usuario que cree una nueva conexión explícitamente.

Nombre	Tipo	Description	Obligatorio
Clave de API	securestring	La clave de API de esta API	Cierto

Limitaciones

Nombre	Llamadas	Período de renovación
Llamadas API por conexión	100	60 segundos

Acciones

Actualizar un artículo	Actualice un artículo existente con el identificador {id} con los datos proporcionados en la carga como JSON. Devuelve un resultado de acción en caso correcto.
Actualizar un contacto	Actualizar un contacto
Actualizar vale	Actualizar un vale
Cargar un archivo	Use este punto de conexión para cargar archivos, por ejemplo, vales o facturas.
Cargar un archivo en un vale	Cargue y asigne archivos (pdf o imagen) al vale identificado por {id}.
Creación de un artículo	El contenido del artículo se espera en el cuerpo de la solicitud como una aplicación/json.
Creación de una asignación	La asignación creada no se mostrará en la lista principal de cupones de lexoffice, pero se adjuntará a una factura y estará visible allí. Para proporcionar a sus clientes acceso al anclaje creado, use nuestra función deeplink.
Crear un contacto	Crear un nuevo contacto
Crear un vale	Crear vales (restringidos a los vales de venta)
Crear una cita	Las comillas transmitidas a través de la API se crean en modo borrador por valor predeterminado. Para crear una cita finalizada con el estado, debe establecerse el parámetro de consulta opcional finalizado. El estado de una comilla no se puede cambiar a través de la API.
Crear una confirmación de pedido	Este punto de conexión proporciona acceso de lectura y escritura a confirmaciones de pedido y también la posibilidad de representar el documento como PDF para descargarlo. Las confirmaciones de pedido siempre se crean en modo borrador y no es necesario finalizar.
Crear una factura	Las facturas transmitidas a través de la API se crean en modo borrador por valor predeterminado. Para crear una factura finalizada con el estado, debe establecerse el parámetro de consulta opcional finalizado. El estado de una factura no se puede cambiar a través de la API.
Crear una nota de crédito	Las notas de crédito transmitidas a través de la API se crean en modo borrador por defecto. Para crear una nota de crédito finalizada con el estado, debe establecerse el parámetro de consulta opcional finalizado. El estado de una nota de crédito no se puede cambiar a través de la API.
Crear una nota de entrega	La nota de entrega creada se mostrará en la lista principal de cupones en lexoffice. Las notas de entrega transmitidas a través de la API solo se crean en modo borrador.
Descargar un archivo	Use este punto de conexión para descargar archivos.
Eliminar un artículo	Elimina el artículo con el valor de identificador {id}. Devuelve 204 si se ejecuta correctamente o 404 si el identificador no existe.
Eliminar un Event-Subscription	Eliminar webHook del desencadenador
Filtrar artículos	Devuelve los artículos que cumplen los criterios proporcionados por los filtros filter_1 para filter_n mediante un mecanismo de paginación. Si se da más de un filtro, el conector lógico es AND. Los filtros que no están establecidos se omiten. Para comprobar el tamaño máximo de página de este punto de conexión, consulte Paginación de recursos.
Presentar un documento de confirmación de pedido (PDF)	Para descargar el archivo pdf de un documento de confirmación de pedido, necesita su documentFileId. Normalmente, el recurso de confirmación del pedido devuelve este identificador. Sin embargo, las confirmaciones de pedido recién creadas a través de la API tienen que desencadenar la representación del archivo de documento pdf por separado. Esto se puede hacer con este punto de conexión.
Recuperación de un artículo	Devuelve el artículo con el valor id {id}.
Recuperación de una asignación	Devuelve el anclaje con el valor id {id}.
Recuperar información de pago	El punto de conexión de pagos proporciona acceso de lectura al estado de pago de los vales (contabilidad o ventas), incluidas las facturas y las notas de crédito.
Recuperar información de perfil	En el ejemplo siguiente se muestra cómo recuperar la información básica del perfil. Es necesario reemplazar el marcador de posición {accessToken} antes de enviar la solicitud.
Recuperar lista de condiciones de pago	En el ejemplo siguiente se muestra cómo recuperar la lista de condiciones de pago configuradas actualmente. Es necesario reemplazar el marcador de posición {accessToken} antes de enviar la solicitud.
Recuperar lista de países	Lista de países conocidos por lexoffice.
Recuperar todas las plantillas periódicas	Recupere una colección de plantillas periódicas. El resultado devuelve solo parte de los datos más relevantes que son el contacto al que se hace referencia (solo el identificador y el nombre), el precio total, las condiciones de pago y la configuración completa de plantillas periódicas. Sin embargo, la nomenclatura de objetos y propiedades es la misma.
Recuperar todas las suscripciones de eventos	Recuperar todas las suscripciones de eventos
Recuperar todos los contactos	Recuperar todos los contactos
Recuperar un contacto	Recuperar un contacto por identificador
Recuperar un vale	Enumerar vales de ventas (por ejemplo, facturas, notas de crédito)
Recuperar una comilla	Devuelve la comilla con el valor id {id}. Representar un documento de comillas (PDF)
Recuperar una confirmación de pedido	Devuelve la confirmación del pedido con el valor id {id}.
Recuperar una factura	Devuelve la factura con el valor id {id}.
Recuperar una factura de pago por adelantado	Devuelve la factura de pago descendente con el valor de identificador {id}.
Recuperar una lista de categorías de publicación	Este punto de conexión proporciona acceso de lectura a la lista de categorías de contabilización de los vales de vales (contabilidad) ingresos o gastos que se admiten en lexoffice.
Recuperar una nota de crédito	Este punto de conexión proporciona acceso de lectura y escritura a las notas de crédito y también la posibilidad de representar el documento como pdf para descargarlo. Las notas de crédito se pueden crear como un borrador o finalizar en modo abierto.
Recuperar una nota de entrega	Devuelve la nota de entrega con el valor id {id}.
Recuperar una plantilla periódica	Devuelve la plantilla periódica con el valor id {id}.
Recuperar una suscripción de eventos	Recuperar una suscripción de eventos
Recuperar y filtrar la lista de vales	Obtener vales de la lista de cupones (contabilidad) (por ejemplo, salesinvoices, salescreditnotes), facturas (incluidas facturas de pago descendente), notas de crédito, confirmaciones de pedido, presupuestos y notas de entrega.
Representación de un documento de asignación (PDF)	Para descargar el archivo pdf de un documento de asignación, necesita su documentFileId. Normalmente, el recurso de astuciación devuelve este identificador. Sin embargo, los anclajes recién creados a través de la API tienen que desencadenar la representación del archivo de documento pdf por separado. Esto se puede hacer con este punto de conexión.
Representar un documento de comillas (PDF)	Para descargar el archivo pdf de un documento de presupuesto, necesita su documentFileId. Normalmente, el recurso de comillas devuelve este identificador. Sin embargo, las citas recién creadas en estado abiertas a través de la API tienen que desencadenar la representación del archivo de documento pdf por separado. Esto se puede hacer con este punto de conexión.
Representar un documento de factura (PDF)	Para descargar el archivo pdf de un documento de factura, necesita su documentFileId. Normalmente, el recurso de factura devuelve este identificador. Sin embargo, las facturas recién creadas en estado abiertas a través de la API tienen que desencadenar la representación del archivo de documento pdf por separado. Esto se puede hacer con este punto de conexión.
Representar un documento de nota de crédito (PDF)	Para descargar el archivo PDF de un documento de nota de crédito, necesita su documentFileId. Este identificador normalmente lo devuelve el recurso de nota de crédito. Sin embargo, las notas de crédito recién creadas en estado abierto a través de la API tienen que desencadenar la representación del archivo de documento pdf por separado. Esto se puede hacer con este punto de conexión.
Representar un documento de nota de entrega (PDF)	Este punto de conexión proporciona acceso de lectura y escritura a las notas de entrega y también la posibilidad de representar el documento como pdf para descargarlo. Las notas de entrega siempre se crean en modo borrador y no es necesario finalizar.

Actualizar un artículo

Id. de la operación:: UpdateAnArticle

Actualice un artículo existente con el identificador {id} con los datos proporcionados en la carga como JSON. Devuelve un resultado de acción en caso correcto.

Parámetros

Nombre	Clave	Requerido	Tipo	Description
Id	id	True	string	Especifique el identificador.
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
taxRate	taxRate		float	taxRate
title	title		string	title
type	type	True	string	type
unitName	unitName	True	string	unitName
version	version	True	integer	version

Devoluciones

Body: Response_articles_id_get

Actualizar un contacto

Id. de la operación:: UpdateContact

Actualizar un contacto

Parámetros

Nombre	Clave	Requerido	Tipo	Description
Id	id	True	string	Especifique el identificador.

Devoluciones

Body: Response_contacts_id_put

Actualizar vale

Id. de la operación:: UpdateVoucher

Actualizar un vale

Parámetros

Nombre	Clave	Requerido	Tipo	Description
Id	id	True	string	Especifique el identificador.
contactId	contactId		string
dueDate	dueDate		date
files	files		array of string	lista de omit fileIds
comentario	remark		string
shippingDate	shippingDate		date
taxType	taxType	True	string
totalGrossAmount	totalGrossAmount		float
totalTaxAmount	totalTaxAmount		float
type	type	True	string
useCollectiveContact	useCollectiveContact		boolean
version	version		integer
voucherDate	voucherDate		date
importe	amount		float
categoryId	categoryId		string
taxAmount	taxAmount		float
taxRatePercent	taxRatePercent		integer
voucherNumber	voucherNumber		string
voucherStatus	voucherStatus		string

Devoluciones

Body: Response_vouchers_id_put

Cargar un archivo

Id. de la operación:: UploadFile_Lexoffice

Use este punto de conexión para cargar archivos, por ejemplo, vales o facturas.

Parámetros

Nombre	Clave	Requerido	Tipo	Description
Archivo	file	True	file	Archivo que se va a cargar.
Tipo	type	True	string	Descripción del contenido del archivo.

Devoluciones

Body: Response_files_post

Cargar un archivo en un vale

Id. de la operación:: UploadFileVoucher_Lexoffice

Cargue y asigne archivos (pdf o imagen) al vale identificado por {id}.

Parámetros

Nombre	Clave	Requerido	Tipo	Description
Id	id	True	string	Especifique el identificador.
Archivo	file	True	file	Archivo que se va a cargar.

Creación de un artículo

Id. de la operación:: CreateArticle

El contenido del artículo se espera en el cuerpo de la solicitud como una aplicación/json.

Parámetros

Nombre	Clave	Tipo	Description
articleNumber	articleNumber	string	articleNumber
grossPrice	grossPrice	float	grossPrice
leadingPrice	leadingPrice	string	leadingPrice
netPrice	netPrice	float	netPrice
taxRate	taxRate	float	taxRate
title	title	string	title
type	type	string	type
unitName	unitName	string	unitName

Devoluciones

Body: Response_articles_post

Creación de una asignación

Id. de la operación:: CreateDunning

La asignación creada no se mostrará en la lista principal de cupones de lexoffice, pero se adjuntará a una factura y estará visible allí. Para proporcionar a sus clientes acceso al anclaje creado, use nuestra función deeplink.

Parámetros

Nombre	Clave	Requerido	Tipo	Description
Identificador de vale de ventas anterior	precedingSalesVoucherId		string	Especifique el identificador del vale de ventas anterior.

Devoluciones

Body: Response_dunnings_post

Crear un contacto

Id. de la operación:: CreateContact

Crear un nuevo contacto

Devoluciones

Body: Response_contacts_post

Crear un vale

Id. de la operación:: CreateVoucher

Crear vales (restringidos a los vales de venta)

Parámetros

Nombre	Clave	Requerido	Tipo
contactId	contactId		string
dueDate	dueDate		date
comentario	remark		string
shippingDate	shippingDate		date
taxType	taxType	True	string
totalGrossAmount	totalGrossAmount		float
totalTaxAmount	totalTaxAmount		float
type	type	True	string
useCollectiveContact	useCollectiveContact		boolean
voucherDate	voucherDate		date
importe	amount		float
categoryId	categoryId		string
taxAmount	taxAmount		float
taxRatePercent	taxRatePercent		integer
voucherNumber	voucherNumber		string
voucherStatus	voucherStatus		string

Devoluciones

Body: Response_vouchers_post

Crear una cita

Id. de la operación:: CreateQuotation

Las comillas transmitidas a través de la API se crean en modo borrador por valor predeterminado. Para crear una cita finalizada con el estado, debe establecerse el parámetro de consulta opcional finalizado. El estado de una comilla no se puede cambiar a través de la API.

Parámetros

Nombre	Clave	Requerido	Tipo	Description
Ultimar	finalize	True	boolean	Especifique la finalización.

Devoluciones

Body: Response_quotations_post

Crear una confirmación de pedido

Id. de la operación:: CreateOrderConfirmation

Este punto de conexión proporciona acceso de lectura y escritura a confirmaciones de pedido y también la posibilidad de representar el documento como PDF para descargarlo. Las confirmaciones de pedido siempre se crean en modo borrador y no es necesario finalizar.

Parámetros

Nombre	Clave	Requerido	Tipo	Description
Identificador de vale de ventas anterior	precedingSalesVoucherId		string	Especifique el identificador del vale de ventas anterior.

Devoluciones

Body: Response_order-confirmations_post

Crear una factura

Id. de la operación:: CreateInvoice

Las facturas transmitidas a través de la API se crean en modo borrador por valor predeterminado. Para crear una factura finalizada con el estado, debe establecerse el parámetro de consulta opcional finalizado. El estado de una factura no se puede cambiar a través de la API.

Parámetros

Nombre	Clave	Requerido	Tipo	Description
Identificador de vale de ventas anterior	precedingSalesVoucherId		string	Especifique el identificador del vale de ventas anterior.
Ultimar	finalize	True	boolean	Especifique la finalización.

Devoluciones

Body: Response_invoices_post

Crear una nota de crédito

Id. de la operación:: CreateCreditNote

Las notas de crédito transmitidas a través de la API se crean en modo borrador por defecto. Para crear una nota de crédito finalizada con el estado, debe establecerse el parámetro de consulta opcional finalizado. El estado de una nota de crédito no se puede cambiar a través de la API.

Parámetros

Nombre	Clave	Requerido	Tipo	Description
Identificador de vale de ventas anterior	precedingSalesVoucherId		string	Especifique el identificador del vale de ventas anterior.
Ultimar	finalize	True	boolean	Especifique la finalización.

Devoluciones

Body: Response_credit-notes_post

Crear una nota de entrega

Id. de la operación:: CreateDeliveryNote

La nota de entrega creada se mostrará en la lista principal de cupones en lexoffice. Las notas de entrega transmitidas a través de la API solo se crean en modo borrador.

Parámetros

Nombre	Clave	Requerido	Tipo	Description
Identificador de vale de ventas anterior	precedingSalesVoucherId		string	Especifique el identificador del vale de ventas anterior.

Devoluciones

Body: Response_delivery-notes_post

Descargar un archivo

Id. de la operación:: DownloadFile_Lexoffice

Use este punto de conexión para descargar archivos.

Parámetros

Nombre	Clave	Requerido	Tipo	Description
Id. de archivo	fileId	True	string	Especifique el identificador de archivo.
Aceptar	Accept		string	Especifique la aceptación.

Devoluciones

response: file

Eliminar un artículo

Id. de la operación:: DeleteAnArticle

Elimina el artículo con el valor de identificador {id}. Devuelve 204 si se ejecuta correctamente o 404 si el identificador no existe.

Parámetros

Nombre	Clave	Requerido	Tipo	Description
Id	id	True	string	Especifique el identificador.

Eliminar un Event-Subscription

Id. de la operación:: DeleteEventSubscription

Eliminar webHook del desencadenador

Parámetros

Nombre	Clave	Requerido	Tipo	Description
Id. de suscripción	subscriptionId	True	string	Especifique el identificador de suscripción.

Filtrar artículos

Id. de la operación:: FilteringArticles

Devuelve los artículos que cumplen los criterios proporcionados por los filtros filter_1 para filter_n mediante un mecanismo de paginación. Si se da más de un filtro, el conector lógico es AND. Los filtros que no están establecidos se omiten. Para comprobar el tamaño máximo de página de este punto de conexión, consulte Paginación de recursos.

Parámetros

Nombre	Clave	Tipo	Description
Número de artículo	articleNumber	string	Especifique el número de artículo.
Gtin	gtin	string	Especifique el gtin.
Tipo	type	string	Especifique el tipo.
Página	page	integer	Especifique la página.
Tamaño	size	integer	Especifique el tamaño.
Ordenar	sort	string	Especifique la ordenación.

Devoluciones

Body: Response_articles_get

Presentar un documento de confirmación de pedido (PDF)

Id. de la operación:: RenderOrderConfirmationDocument

Para descargar el archivo pdf de un documento de confirmación de pedido, necesita su documentFileId. Normalmente, el recurso de confirmación del pedido devuelve este identificador. Sin embargo, las confirmaciones de pedido recién creadas a través de la API tienen que desencadenar la representación del archivo de documento pdf por separado. Esto se puede hacer con este punto de conexión.

Parámetros

Nombre	Clave	Requerido	Tipo	Description
Id	id	True	string	Especifique el identificador.

Devoluciones

Nombre	Ruta de acceso	Tipo	Description
documentFileId	documentFileId	uuid

Recuperación de un artículo

Id. de la operación:: RetrieveAnArticle

Devuelve el artículo con el valor id {id}.

Parámetros

Nombre	Clave	Requerido	Tipo	Description
Id	id	True	string	Especifique el identificador.

Devoluciones

Nombre	Ruta de acceso	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
taxRate	price.taxRate	float
title	title	string
type	type	string
unitName	unitName	string
version	version	integer

Recuperación de una asignación

Id. de la operación:: RetrieveDunning

Devuelve el anclaje con el valor id {id}.

Parámetros

Nombre	Clave	Requerido	Tipo	Description
Dunningsid	dunningsid	True	string	Especifique el dunningsid.

Devoluciones

Nombre	Ruta de acceso	Tipo
city	address.city	string
countryCode	address.countryCode	string
nombre	address.name	string
street	address.street	string
Suplemento	address.supplement	string
archivo comprimido	address.zip	string
Archivados	archived	boolean
fecha de creación	createdDate	date-time
id	id	uuid
Introducción	introduction	string
lenguaje	language	string
lineItems	lineItems	array of object
discountPercentage	lineItems.discountPercentage	number
lineItemAmount	lineItems.lineItemAmount	number
nombre	lineItems.name	string
quantity	lineItems.quantity	number
type	lineItems.type	string
unitName	lineItems.unitName	string
Moneda	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
comentario	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
Moneda	totalPrice.currency	string
totalGrossAmount	totalPrice.totalGrossAmount	number
totalNetAmount	totalPrice.totalNetAmount	number
totalTaxAmount	totalPrice.totalTaxAmount	number
updatedDate	updatedDate	date-time
version	version	integer
voucherDate	voucherDate	date-time
voucherStatus	voucherStatus	string

Recuperar información de pago

Id. de la operación:: RetrievePaymentInformation

El punto de conexión de pagos proporciona acceso de lectura al estado de pago de los vales (contabilidad o ventas), incluidas las facturas y las notas de crédito.

Parámetros

Nombre	Clave	Requerido	Tipo	Description
Id. de vale	voucherId	True	string	Especifique el identificador del vale.

Devoluciones

Nombre	Ruta de acceso	Tipo
Moneda	currency	string
openAmount	openAmount	string
paymentItems	paymentItems	array of object
importe	paymentItems.amount	float
Moneda	paymentItems.currency	string
paymentItemType	paymentItems.paymentItemType	string
postingDate	paymentItems.postingDate	date-time
paymentStatus	paymentStatus	string
voucherStatus	voucherStatus	string
voucherType	voucherType	string

Recuperar información de perfil

Id. de la operación:: RetrieveProfileInformation

En el ejemplo siguiente se muestra cómo recuperar la información básica del perfil. Es necesario reemplazar el marcador de posición {accessToken} antes de enviar la solicitud.

Devoluciones

Body: Response_profile_get

Recuperar lista de condiciones de pago

Id. de la operación:: RetrieveListOfPaymentConditions

En el ejemplo siguiente se muestra cómo recuperar la lista de condiciones de pago configuradas actualmente. Es necesario reemplazar el marcador de posición {accessToken} antes de enviar la solicitud.

Devoluciones

response: array of Response_payment-conditions_get_items

Recuperar lista de países

Id. de la operación:: RetrieveListCountries

Lista de países conocidos por lexoffice.

Devoluciones

response: array of Response_countries_get_default

Recuperar todas las plantillas periódicas

Id. de la operación:: RetrieveAllRecurringTemplates

Recupere una colección de plantillas periódicas. El resultado devuelve solo parte de los datos más relevantes que son el contacto al que se hace referencia (solo el identificador y el nombre), el precio total, las condiciones de pago y la configuración completa de plantillas periódicas. Sin embargo, la nomenclatura de objetos y propiedades es la misma.

Parámetros

Nombre	Clave	Tipo	Description
Página	page	integer	Especifique la página.
Tamaño	size	integer	Especifique el tamaño.
Ordenar	sort	string	Especifique la ordenación.

Devoluciones

Body: Response_recurring-templates_get

Recuperar todas las suscripciones de eventos

Id. de la operación:: RetrieveAllEventSubscriptions

Recuperar todas las suscripciones de eventos

Devoluciones

Body: Response_event-subscriptions_get

Recuperar todos los contactos

Id. de la operación:: RetrieveAllContacts

Recuperar todos los contactos

Parámetros

Nombre	Clave	Tipo	Description
Number	number	integer	Especifique el número.
Correo Electrónico	email	string	Especifique el correo electrónico.
Nombre	name	string	Especifique el nombre.
Proveedor	vendor	boolean	Especifique el proveedor.
Cliente	customer	boolean	Especifique el cliente.
Página	page	integer	Especifique la página.
Tamaño	size	integer	Especifique el tamaño.
Ordenar	sort	string	Especifique la ordenación.

Devoluciones

Body: Response_contacts_get

Recuperar un contacto

Id. de la operación:: RetrieveContact

Recuperar un contacto por identificador

Parámetros

Nombre	Clave	Requerido	Tipo	Description
Id	id	True	string	Especifique el identificador.

Devoluciones

Nombre	Ruta de acceso	Tipo
Archivados	archived	boolean
id	id	string
organizationId	organizationId	string
firstName	person.firstName	string
lastName	person.lastName	string
saludo	person.salutation	string
number	roles.customer.number	integer
version	version	integer

Recuperar un vale

Id. de la operación:: RetrieveVoucher

Enumerar vales de ventas (por ejemplo, facturas, notas de crédito)

Parámetros

Nombre	Clave	Requerido	Tipo	Description
Id	id	True	string	Especifique el identificador.

Devoluciones

Nombre	Ruta de acceso	Tipo
fecha de creación	createdDate	date-time
dueDate	dueDate	date-time
files	files	array of string
id	id	uuid
organizationId	organizationId	uuid
comentario	remark	string
shippingDate	shippingDate	date-time
taxType	taxType	string
totalGrossAmount	totalGrossAmount	number
totalTaxAmount	totalTaxAmount	number
type	type	string
updatedDate	updatedDate	date-time
useCollectiveContact	useCollectiveContact	boolean
version	version	integer
voucherDate	voucherDate	date-time
voucherItems	voucherItems	array of object
importe	voucherItems.amount	number
categoryId	voucherItems.categoryId	uuid
taxAmount	voucherItems.taxAmount	number
taxRatePercent	voucherItems.taxRatePercent	number
voucherNumber	voucherNumber	string
voucherStatus	voucherStatus	string

Recuperar una comilla

Id. de la operación:: RetrieveQuotation

Devuelve la comilla con el valor id {id}. Representar un documento de comillas (PDF)

Parámetros

Nombre	Clave	Requerido	Tipo	Description
Id	id	True	string	Especifique el identificador.

Devoluciones

Nombre	Ruta de acceso	Tipo
city	address.city	string
contactId	address.contactId	uuid
countryCode	address.countryCode	string
nombre	address.name	string
street	address.street	string
archivo comprimido	address.zip	string
Archivados	archived	boolean
fecha de creación	createdDate	date-time
fecha de vencimiento	expirationDate	date-time
documentFileId	files.documentFileId	uuid
id	id	uuid
Introducción	introduction	string
lenguaje	language	string
lineItems	lineItems	array of object
alternativa	lineItems.alternative	boolean
discountPercentage	lineItems.discountPercentage	number
id	lineItems.id	uuid
lineItemAmount	lineItems.lineItemAmount	number
nombre	lineItems.name	string
opcional	lineItems.optional	boolean
quantity	lineItems.quantity	number
Subelementos	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
nombre	lineItems.subItems.name	string
opcional	lineItems.subItems.optional	boolean
quantity	lineItems.subItems.quantity	number
type	lineItems.subItems.type	string
unitName	lineItems.subItems.unitName	string
Moneda	lineItems.subItems.unitPrice.currency	string
grossAmount	lineItems.subItems.unitPrice.grossAmount	number
netAmount	lineItems.subItems.unitPrice.netAmount	number
taxRatePercentage	lineItems.subItems.unitPrice.taxRatePercentage	number
type	lineItems.type	string
unitName	lineItems.unitName	string
Moneda	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
comentario	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
Moneda	totalPrice.currency	string
totalGrossAmount	totalPrice.totalGrossAmount	number
totalNetAmount	totalPrice.totalNetAmount	number
totalTaxAmount	totalPrice.totalTaxAmount	number
updatedDate	updatedDate	date-time
version	version	integer
voucherDate	voucherDate	date-time
voucherNumber	voucherNumber	string
voucherStatus	voucherStatus	string

Recuperar una confirmación de pedido

Id. de la operación:: RetrieveOrderConfirmation

Devuelve la confirmación del pedido con el valor id {id}.

Parámetros

Nombre	Clave	Requerido	Tipo	Description
Id	id	True	string	Especifique el identificador.

Devoluciones

Nombre	Ruta de acceso	Tipo
city	address.city	string
countryCode	address.countryCode	string
nombre	address.name	string
street	address.street	string
Suplemento	address.supplement	string
archivo comprimido	address.zip	string
Archivados	archived	boolean
fecha de creación	createdDate	date-time
deliveryTerms	deliveryTerms	string
documentFileId	files.documentFileId	uuid
id	id	uuid
Introducción	introduction	string
lenguaje	language	string
lineItems	lineItems	array of object
discountPercentage	lineItems.discountPercentage	number
id	lineItems.id	uuid
lineItemAmount	lineItems.lineItemAmount	number
nombre	lineItems.name	string
quantity	lineItems.quantity	number
type	lineItems.type	string
unitName	lineItems.unitName	string
Moneda	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
comentario	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
Moneda	totalPrice.currency	string
totalGrossAmount	totalPrice.totalGrossAmount	number
totalNetAmount	totalPrice.totalNetAmount	number
totalTaxAmount	totalPrice.totalTaxAmount	number
updatedDate	updatedDate	date-time
version	version	integer
voucherDate	voucherDate	date-time
voucherNumber	voucherNumber	string
voucherStatus	voucherStatus	string

Recuperar una factura

Id. de la operación:: RetrieveInvoice

Devuelve la factura con el valor id {id}.

Parámetros

Nombre	Clave	Requerido	Tipo	Description
Id	id	True	string	Especifique el identificador.

Devoluciones

Nombre	Ruta de acceso	Tipo
city	address.city	string
countryCode	address.countryCode	string
nombre	address.name	string
street	address.street	string
Suplemento	address.supplement	string
archivo comprimido	address.zip	string
Archivados	archived	boolean
fecha de creación	createdDate	date-time
id	id	uuid
Introducción	introduction	string
lenguaje	language	string
lineItems	lineItems	array of object
discountPercentage	lineItems.discountPercentage	number
id	lineItems.id	uuid
lineItemAmount	lineItems.lineItemAmount	number
nombre	lineItems.name	string
quantity	lineItems.quantity	number
type	lineItems.type	string
unitName	lineItems.unitName	string
Moneda	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
comentario	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
Moneda	totalPrice.currency	string
totalGrossAmount	totalPrice.totalGrossAmount	number
totalNetAmount	totalPrice.totalNetAmount	number
totalTaxAmount	totalPrice.totalTaxAmount	number
updatedDate	updatedDate	date-time
version	version	integer
voucherDate	voucherDate	date-time
voucherNumber	voucherNumber	string
voucherStatus	voucherStatus	string

Recuperar una factura de pago por adelantado

Id. de la operación:: RetrieveDownPaymentInvoice

Devuelve la factura de pago descendente con el valor de identificador {id}.

Parámetros

Nombre	Clave	Requerido	Tipo	Description
Id	id	True	string	Especifique el identificador.

Devoluciones

Nombre	Ruta de acceso	Tipo
city	address.city	string
countryCode	address.countryCode	string
nombre	address.name	string
street	address.street	string
Suplemento	address.supplement	string
archivo comprimido	address.zip	string
Archivados	archived	boolean
closingInvoiceId	closingInvoiceId	uuid
fecha de creación	createdDate	date-time
dueDate	dueDate	date-time
documentFileId	files.documentFileId	uuid
id	id	uuid
Introducción	introduction	string
lenguaje	language	string
lineItems	lineItems	array of object
lineItemAmount	lineItems.lineItemAmount	number
nombre	lineItems.name	string
quantity	lineItems.quantity	number
type	lineItems.type	string
Moneda	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
comentario	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
Moneda	totalPrice.currency	string
totalGrossAmount	totalPrice.totalGrossAmount	number
totalNetAmount	totalPrice.totalNetAmount	number
totalTaxAmount	totalPrice.totalTaxAmount	number
updatedDate	updatedDate	date-time
version	version	integer
voucherDate	voucherDate	date-time
voucherNumber	voucherNumber	string
voucherStatus	voucherStatus	string

Recuperar una lista de categorías de publicación

Id. de la operación:: RetrieveListPostingCategories

Este punto de conexión proporciona acceso de lectura a la lista de categorías de contabilización de los vales de vales (contabilidad) ingresos o gastos que se admiten en lexoffice.

Devoluciones

response: array of Response_posting-categories_get_items

Recuperar una nota de crédito

Id. de la operación:: RetrieveCreditNote

Este punto de conexión proporciona acceso de lectura y escritura a las notas de crédito y también la posibilidad de representar el documento como pdf para descargarlo. Las notas de crédito se pueden crear como un borrador o finalizar en modo abierto.

Parámetros

Nombre	Clave	Requerido	Tipo	Description
Id	id	True	string	Especifique el identificador.

Devoluciones

Nombre	Ruta de acceso	Tipo
city	address.city	string
countryCode	address.countryCode	string
nombre	address.name	string
street	address.street	string
Suplemento	address.supplement	string
archivo comprimido	address.zip	string
Archivados	archived	boolean
fecha de creación	createdDate	date-time
id	id	uuid
Introducción	introduction	string
lenguaje	language	string
lineItems	lineItems	array of object
lineItemAmount	lineItems.lineItemAmount	number
nombre	lineItems.name	string
quantity	lineItems.quantity	number
type	lineItems.type	string
unitName	lineItems.unitName	string
Moneda	lineItems.unitPrice.currency	string
grossAmount	lineItems.unitPrice.grossAmount	float
netAmount	lineItems.unitPrice.netAmount	float
taxRatePercentage	lineItems.unitPrice.taxRatePercentage	number
organizationId	organizationId	uuid
comentario	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
Moneda	totalPrice.currency	string
totalGrossAmount	totalPrice.totalGrossAmount	float
totalNetAmount	totalPrice.totalNetAmount	float
totalTaxAmount	totalPrice.totalTaxAmount	float
updatedDate	updatedDate	date-time
version	version	integer
voucherDate	voucherDate	date-time
voucherNumber	voucherNumber	string
voucherStatus	voucherStatus	string

Recuperar una nota de entrega

Id. de la operación:: RetrieveDeliveryNote

Devuelve la nota de entrega con el valor id {id}.

Parámetros

Nombre	Clave	Requerido	Tipo	Description
Id	id	True	string	Especifique el identificador.

Devoluciones

Nombre	Ruta de acceso	Tipo
city	address.city	string
countryCode	address.countryCode	string
nombre	address.name	string
street	address.street	string
Suplemento	address.supplement	string
archivo comprimido	address.zip	string
Archivados	archived	boolean
fecha de creación	createdDate	date-time
deliveryTerms	deliveryTerms	string
id	id	uuid
Introducción	introduction	string
lenguaje	language	string
lineItems	lineItems	array of object
nombre	lineItems.name	string
quantity	lineItems.quantity	number
type	lineItems.type	string
unitName	lineItems.unitName	string
Moneda	lineItems.unitPrice.currency	string
grossAmount	lineItems.unitPrice.grossAmount	number
netAmount	lineItems.unitPrice.netAmount	number
taxRatePercentage	lineItems.unitPrice.taxRatePercentage	number
organizationId	organizationId	uuid
comentario	remark	string
taxType	taxConditions.taxType	string
title	title	string
updatedDate	updatedDate	date-time
version	version	integer
voucherDate	voucherDate	date-time
voucherNumber	voucherNumber	string
voucherStatus	voucherStatus	string

Recuperar una plantilla periódica

Id. de la operación:: RetrieveRecurringTemplate

Devuelve la plantilla periódica con el valor id {id}.

Parámetros

Nombre	Clave	Requerido	Tipo	Description
Id	id	True	string	Especifique el identificador.

Devoluciones

Nombre	Ruta de acceso	Tipo
city	address.city	string
contactId	address.contactId	uuid
countryCode	address.countryCode	string
nombre	address.name	string
street	address.street	string
archivo comprimido	address.zip	string
Archivados	archived	boolean
fecha de creación	createdDate	date-time
id	id	uuid
Introducción	introduction	string
lenguaje	language	string
lineItems	lineItems	array of object
discountPercentage	lineItems.discountPercentage	number
lineItemAmount	lineItems.lineItemAmount	number
nombre	lineItems.name	string
quantity	lineItems.quantity	number
type	lineItems.type	string
unitName	lineItems.unitName	string
Moneda	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
comentario	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
Moneda	totalPrice.currency	string
totalGrossAmount	totalPrice.totalGrossAmount	number
totalNetAmount	totalPrice.totalNetAmount	number
totalTaxAmount	totalPrice.totalTaxAmount	number
updatedDate	updatedDate	date-time
version	version	integer

Recuperar una suscripción de eventos

Id. de la operación:: RetrieveAEventSubscription

Recuperar una suscripción de eventos

Parámetros

Nombre	Clave	Requerido	Tipo	Description
Id. de suscripción	subscriptionId	True	string	Especifique el identificador de suscripción.

Devoluciones

Body: EventSubscriptionResponse

Recuperar y filtrar la lista de vales

Id. de la operación:: RetrieveAndFilterVoucherlist

Obtener vales de la lista de cupones (contabilidad) (por ejemplo, salesinvoices, salescreditnotes), facturas (incluidas facturas de pago descendente), notas de crédito, confirmaciones de pedido, presupuestos y notas de entrega.

Parámetros

Nombre	Clave	Requerido	Tipo	Description
Tipo de vale	voucherType	True	string	Especifique el tipo de vale.
Estado del vale	voucherStatus	True	string	Especifique el estado del vale.
Archivado	archived		boolean	Especifique el archivo.
ID de contacto	contactId		string	Especifique el identificador de contacto.
Fecha de vale a partir de	voucherDateFrom		string	Especifique la fecha del vale.
Fecha del vale a	voucherDateTo		string	Especifique la fecha del vale para.
Fecha de creación a partir de	createdDateFrom		string	Especifique la fecha de creación a partir de.
Fecha de creación a	createdDateTo		string	Especifique la fecha de creación que se va a.
Fecha de actualización a partir de	updatedDateFrom		string	Especifique la fecha actualizada a partir de .
Fecha actualizada a	updatedDateTo		string	Especifique la fecha actualizada a.
Número de vale	voucherNumber		string	Especifique el número de vale.
Página	page		integer	Especifique la página.
Tamaño	size		integer	Especifique el tamaño.
Ordenar	sort		string	Especifique la ordenación.

Devoluciones

Body: Response_voucherlist_get

Representación de un documento de asignación (PDF)

Id. de la operación:: RenderDunningDocument

Para descargar el archivo pdf de un documento de asignación, necesita su documentFileId. Normalmente, el recurso de astuciación devuelve este identificador. Sin embargo, los anclajes recién creados a través de la API tienen que desencadenar la representación del archivo de documento pdf por separado. Esto se puede hacer con este punto de conexión.

Parámetros

Nombre	Clave	Requerido	Tipo	Description
Dunningsid	dunningsid	True	string	Especifique el dunningsid.

Devoluciones

Nombre	Ruta de acceso	Tipo	Description
documentFileId	documentFileId	uuid

Representar un documento de comillas (PDF)

Id. de la operación:: RenderQuotationDocument

Para descargar el archivo pdf de un documento de presupuesto, necesita su documentFileId. Normalmente, el recurso de comillas devuelve este identificador. Sin embargo, las citas recién creadas en estado abiertas a través de la API tienen que desencadenar la representación del archivo de documento pdf por separado. Esto se puede hacer con este punto de conexión.

Parámetros

Nombre	Clave	Requerido	Tipo	Description
Id	id	True	string	Especifique el identificador.

Devoluciones

Nombre	Ruta de acceso	Tipo	Description
documentFileId	documentFileId	uuid

Representar un documento de factura (PDF)

Id. de la operación:: RenderInvoiceDocument

Para descargar el archivo pdf de un documento de factura, necesita su documentFileId. Normalmente, el recurso de factura devuelve este identificador. Sin embargo, las facturas recién creadas en estado abiertas a través de la API tienen que desencadenar la representación del archivo de documento pdf por separado. Esto se puede hacer con este punto de conexión.

Parámetros

Nombre	Clave	Requerido	Tipo	Description
Id	id	True	string	Especifique el identificador.

Devoluciones

Nombre	Ruta de acceso	Tipo	Description
documentFileId	documentFileId	uuid

Representar un documento de nota de crédito (PDF)

Id. de la operación:: RenderCreditNoteDocument

Para descargar el archivo PDF de un documento de nota de crédito, necesita su documentFileId. Este identificador normalmente lo devuelve el recurso de nota de crédito. Sin embargo, las notas de crédito recién creadas en estado abierto a través de la API tienen que desencadenar la representación del archivo de documento pdf por separado. Esto se puede hacer con este punto de conexión.

Parámetros

Nombre	Clave	Requerido	Tipo	Description
Id	id	True	string	Especifique el identificador.

Devoluciones

Nombre	Ruta de acceso	Tipo	Description
documentFileId	documentFileId	uuid

Representar un documento de nota de entrega (PDF)

Id. de la operación:: RenderDeliveryNoteDocument

Este punto de conexión proporciona acceso de lectura y escritura a las notas de entrega y también la posibilidad de representar el documento como pdf para descargarlo. Las notas de entrega siempre se crean en modo borrador y no es necesario finalizar.

Parámetros

Nombre	Clave	Requerido	Tipo	Description
Noteid de entrega	DeliveryNoteid	True	string	Especifique el noteid de entrega.

Devoluciones

Nombre	Ruta de acceso	Tipo
city	address.city	string
countryCode	address.countryCode	string
nombre	address.name	string
street	address.street	string
Suplemento	address.supplement	string
archivo comprimido	address.zip	string
Archivados	archived	boolean
fecha de creación	createdDate	date-time
deliveryTerms	deliveryTerms	string
id	id	uuid
Introducción	introduction	string
lenguaje	language	string
lineItems	lineItems	array of object
nombre	lineItems.name	string
quantity	lineItems.quantity	number
type	lineItems.type	string
unitName	lineItems.unitName	string
Moneda	lineItems.unitPrice.currency	string
grossAmount	lineItems.unitPrice.grossAmount	float
netAmount	lineItems.unitPrice.netAmount	float
taxRatePercentage	lineItems.unitPrice.taxRatePercentage	number
organizationId	organizationId	uuid
comentario	remark	string
taxType	taxConditions.taxType	string
title	title	string
updatedDate	updatedDate	date-time
version	version	integer
voucherDate	voucherDate	date-time
voucherNumber	voucherNumber	string
voucherStatus	voucherStatus	string

Desencadenadores

Selección del desencadenador personalizado

Registro de un nuevo desencadenador para el punto de conexión de contactos

Selección del desencadenador personalizado

Id. de la operación:: EventSubscription_Lexoffice

Registro de un nuevo desencadenador para el punto de conexión de contactos

Parámetros

Nombre	Clave	Requerido	Tipo	Description
Tipo de evento	eventType	True	string	eventType

Devoluciones

Nombre	Ruta de acceso	Tipo	Description
eventDate	eventDate	string	eventDate
eventType	eventType	string	eventType
organizationId	organizationId	string	organizationId
resourceId	resourceId	string	resourceId

Definiciones

EventSubscriptionResponse

Nombre	Ruta de acceso	Tipo
ID de suscripción	subscriptionId	string
eventType	eventType	string
organizationId	organizationId	string
fecha de creación	createdDate	date-time
callbackUrl	callbackUrl	string

Response_articles_get

Nombre	Ruta de acceso	Tipo	Description
contenido	content	array of object	contenido
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
taxRate	content.price.taxRate	float	taxRate
title	content.title	string	title
type	content.type	string	type
unitName	content.unitName	string	unitName
version	content.version	integer	version
Primero	first	boolean	Primero
último	last	boolean	último
number	number	integer	number
numberOfElements	numberOfElements	integer	numberOfElements
size	size	integer	size
sort	sort	array of object	sort
ascendente	sort.ascending	boolean	ascendente
direction	sort.direction	string	direction
ignoreCase	sort.ignoreCase	boolean	ignoreCase
nullHandling	sort.nullHandling	string	nullHandling
property	sort.property	string	property
totalElements	totalElements	integer	totalElements
totalPages	totalPages	integer	totalPages

Response_articles_id_get

Nombre	Ruta de acceso	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
taxRate	price.taxRate	float	taxRate
title	title	string	title
type	type	string	type
unitName	unitName	string	unitName
version	version	integer	version

Response_articles_post

Nombre	Ruta de acceso	Tipo	Description
fecha de creación	createdDate	string	fecha de creación
id	id	string	id
resourceUri	resourceUri	string	resourceUri
updatedDate	updatedDate	string	updatedDate
version	version	integer	version

Response_contacts_get

Nombre	Ruta de acceso	Tipo	Description
contenido	content	array of object	contenido
facturación	content.addresses.billing	array of object	facturación
city	content.addresses.billing.city	string	city
countryCode	content.addresses.billing.countryCode	string	countryCode
street	content.addresses.billing.street	string	street
Suplemento	content.addresses.billing.supplement	string	Suplemento
archivo comprimido	content.addresses.billing.zip	string	archivo comprimido
naviero	content.addresses.shipping	array of object	naviero
city	content.addresses.shipping.city	string	city
countryCode	content.addresses.shipping.countryCode	string	countryCode
street	content.addresses.shipping.street	string	street
Suplemento	content.addresses.shipping.supplement	string	Suplemento
archivo comprimido	content.addresses.shipping.zip	string	archivo comprimido
Archivados	content.archived	boolean	Archivados
allowTaxFreeInvoices	content.company.allowTaxFreeInvoices	boolean	allowTaxFreeInvoices
contactPersons	content.company.contactPersons	array of object	contactPersons
dirección de correo electrónico	content.company.contactPersons.emailAddress	string	dirección de correo electrónico
firstName	content.company.contactPersons.firstName	string	firstName
lastName	content.company.contactPersons.lastName	string	lastName
principal	content.company.contactPersons.primary	boolean	principal
saludo	content.company.contactPersons.salutation	string	saludo
nombre	content.company.name	string	nombre
taxNumber	content.company.taxNumber	string	taxNumber
vatRegistrationId	content.company.vatRegistrationId	string	vatRegistrationId
Negocio	content.emailAddresses.business	array of string	Negocio
oficina	content.emailAddresses.office	array of string	oficina
other	content.emailAddresses.other	array of string	other
id	content.id	string	id
Nota	content.note	string	Nota
organizationId	content.organizationId	string	organizationId
Negocio	content.phoneNumbers.business	array of string	Negocio
fax	content.phoneNumbers.fax	array of string	fax
oficina	content.phoneNumbers.office	array of string	oficina
other	content.phoneNumbers.other	array of string	other
number	content.roles.customer.number	integer	number
number	content.roles.vendor.number	integer	number
version	content.version	integer	version
Primero	first	boolean	Primero
último	last	boolean	último
number	number	integer	number
numberOfElements	numberOfElements	integer	numberOfElements
size	size	integer	size
sort	sort	array of object	sort
ascendente	sort.ascending	boolean	ascendente
direction	sort.direction	string	direction
ignoreCase	sort.ignoreCase	boolean	ignoreCase
nullHandling	sort.nullHandling	string	nullHandling
property	sort.property	string	property
totalElements	totalElements	integer	totalElements
totalPages	totalPages	integer	totalPages

Response_contacts_post

Nombre	Ruta de acceso	Tipo	Description
fecha de creación	createdDate	string	fecha de creación
id	id	string	id
resourceUri	resourceUri	string	resourceUri
updatedDate	updatedDate	string	updatedDate
version	version	integer	version

Response_countries_get_default

Nombre	Ruta de acceso	Tipo	Description
countryCode	countryCode	string	countryCode
countryNameDE	countryNameDE	string	countryNameDE
countryNameEN	countryNameEN	string	countryNameEN
taxClassification	taxClassification	string	taxClassification

Response_credit-notes_post

Nombre	Ruta de acceso	Tipo	Description
fecha de creación	createdDate	string	fecha de creación
id	id	string	id
resourceUri	resourceUri	string	resourceUri
updatedDate	updatedDate	string	updatedDate
version	version	integer	version

Response_delivery notes_post

Nombre	Ruta de acceso	Tipo	Description
fecha de creación	createdDate	string	fecha de creación
id	id	string	id
resourceUri	resourceUri	string	resourceUri
updatedDate	updatedDate	string	updatedDate
version	version	integer	version

Response_dunnings_post

Nombre	Ruta de acceso	Tipo	Description
fecha de creación	createdDate	string	fecha de creación
id	id	string	id
resourceUri	resourceUri	string	resourceUri
updatedDate	updatedDate	string	updatedDate
version	version	integer	version

Response_event-subscriptions_get

Nombre	Ruta de acceso	Tipo	Description
contenido	content	array of object	contenido
callbackUrl	content.callbackUrl	string	callbackUrl
fecha de creación	content.createdDate	string	fecha de creación
eventType	content.eventType	string	eventType
organizationId	content.organizationId	string	organizationId
ID de suscripción	content.subscriptionId	string	ID de suscripción

Response_files_post

Nombre	Ruta de acceso	Tipo	Description
id	id	string	id

Response_invoices_post

Nombre	Ruta de acceso	Tipo	Description
fecha de creación	createdDate	string	fecha de creación
id	id	string	id
resourceUri	resourceUri	string	resourceUri
updatedDate	updatedDate	string	updatedDate
version	version	integer	version

Response_order-confirmations_post

Nombre	Ruta de acceso	Tipo	Description
fecha de creación	createdDate	string	fecha de creación
id	id	string	id
resourceUri	resourceUri	string	resourceUri
updatedDate	updatedDate	string	updatedDate
version	version	integer	version

Response_payment-conditions_get_items

Nombre	Ruta de acceso	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

Nombre	Ruta de acceso	Tipo	Description
contactRequired	contactRequired	boolean	contactRequired
groupName	groupName	string	groupName
id	id	string	id
nombre	name	string	nombre
splitAllowed	splitAllowed	boolean	splitAllowed
type	type	string	type

Response_profile_get

Nombre	Ruta de acceso	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
nombre de usuario	created.userName	string	nombre de usuario
features	features	array of string	features
organizationId	organizationId	string	organizationId
smallBusiness	smallBusiness	boolean	smallBusiness
subscriptionStatus	subscriptionStatus	string	subscriptionStatus
taxType	taxType	string	taxType

Response_quotations_post

Nombre	Ruta de acceso	Tipo	Description
fecha de creación	createdDate	string	fecha de creación
id	id	string	id
resourceUri	resourceUri	string	resourceUri
updatedDate	updatedDate	string	updatedDate
version	version	integer	version

Response_recurring-templates_get

Nombre	Ruta de acceso	Tipo	Description
contenido	content	array of object	contenido
contactId	content.address.contactId	string	contactId
nombre	content.address.name	string	nombre
fecha de creación	content.createdDate	string	fecha de creación
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
fecha de finalización	content.recurringTemplateSettings.endDate	string	fecha de finalización
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
Moneda	content.totalPrice.currency	string	Moneda
totalGrossAmount	content.totalPrice.totalGrossAmount	integer	totalGrossAmount
totalNetAmount	content.totalPrice.totalNetAmount	float	totalNetAmount
updatedDate	content.updatedDate	string	updatedDate
Primero	first	boolean	Primero
último	last	boolean	último
number	number	integer	number
numberOfElements	numberOfElements	integer	numberOfElements
size	size	integer	size
sort	sort	array of object	sort
ascendente	sort.ascending	boolean	ascendente
direction	sort.direction	string	direction
ignoreCase	sort.ignoreCase	boolean	ignoreCase
nullHandling	sort.nullHandling	string	nullHandling
property	sort.property	string	property
totalElements	totalElements	integer	totalElements
totalPages	totalPages	integer	totalPages

Response_voucherlist_get

Nombre	Ruta de acceso	Tipo	Description
contenido	content	array of object	contenido
Archivados	content.archived	boolean	Archivados
contactId	content.contactId	string	contactId
contactName	content.contactName	string	contactName
fecha de creación	content.createdDate	string	fecha de creación
Moneda	content.currency	string	Moneda
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
Primero	first	boolean	Primero
último	last	boolean	último
number	number	integer	number
numberOfElements	numberOfElements	integer	numberOfElements
size	size	integer	size
sort	sort	array of object	sort
ascendente	sort.ascending	boolean	ascendente
direction	sort.direction	string	direction
ignoreCase	sort.ignoreCase	boolean	ignoreCase
nullHandling	sort.nullHandling	string	nullHandling
property	sort.property	string	property
totalElements	totalElements	integer	totalElements
totalPages	totalPages	integer	totalPages

Response_vouchers_post

Nombre	Ruta de acceso	Tipo	Description
fecha de creación	createdDate	string	fecha de creación
id	id	string	id
resourceUri	resourceUri	string	resourceUri
updatedDate	updatedDate	string	updatedDate
version	version	integer	version

Response_contacts_id_put

Nombre	Ruta de acceso	Tipo
Archivados	archived	boolean
id	id	uuid
organizationId	organizationId	uuid
firstName	person.firstName	string
lastName	person.lastName	string
saludo	person.salutation	string
number	roles.customer.number	integer
version	version	integer

Response_vouchers_id_put

Nombre	Ruta de acceso	Tipo
fecha de creación	createdDate	date-time
dueDate	dueDate	date-time
files	files	array of object
items	files	object
id	id	uuid
organizationId	organizationId	uuid
comentario	remark	string
shippingDate	shippingDate	date-time
taxType	taxType	string
totalGrossAmount	totalGrossAmount	number
totalTaxAmount	totalTaxAmount	number
type	type	string
updatedDate	updatedDate	date-time
useCollectiveContact	useCollectiveContact	boolean
version	version	integer
voucherDate	voucherDate	date-time
voucherItems	voucherItems	array of object
importe	voucherItems.amount	number
categoryId	voucherItems.categoryId	uuid
taxAmount	voucherItems.taxAmount	number
taxRatePercent	voucherItems.taxRatePercent	number
voucherNumber	voucherNumber	string
voucherStatus	voucherStatus	string

archivo

Este es el tipo de datos básico "file".

Compartir a través de

Lexoffice (Publicador independiente) (versión preliminar)

Conector de la API de Lexware (publicador independiente)

Publicador: publicador independiente

Prerrequisitos

Operaciones admitidas

Obtención de credenciales

Puerta de enlace de API

Límites de velocidad

Autenticación

Ejemplo de uso

Problemas conocidos y limitaciones

Documentación de la API

Creando una conexión

Predeterminado

Limitaciones

Acciones

Actualizar un artículo

Parámetros

Devoluciones

Actualizar un contacto

Parámetros

Devoluciones

Actualizar vale

Parámetros

Devoluciones

Cargar un archivo

Parámetros

Devoluciones

Cargar un archivo en un vale

Parámetros

Creación de un artículo

Parámetros

Devoluciones

Creación de una asignación

Parámetros

Devoluciones

Crear un contacto

Devoluciones

Crear un vale

Parámetros

Devoluciones

Crear una cita

Parámetros

Devoluciones

Crear una confirmación de pedido

Parámetros

Devoluciones

Crear una factura

Parámetros

Devoluciones

Crear una nota de crédito

Parámetros

Devoluciones

Crear una nota de entrega

Parámetros

Devoluciones

Descargar un archivo

Parámetros

Devoluciones

Eliminar un artículo

Parámetros

Eliminar un Event-Subscription

Parámetros

Filtrar artículos

Parámetros

Devoluciones

Presentar un documento de confirmación de pedido (PDF)

Parámetros

Devoluciones

Recuperación de un artículo

Parámetros

Devoluciones

Recuperación de una asignación

Parámetros

Devoluciones

Recuperar información de pago

Parámetros

Devoluciones

Recuperar información de perfil