Lexoffice (независимый издатель) (предварительная версия)

API Lexware предоставляет программный доступ к основным бизнес-функциям Lexware, таким как статьи, контакты, счета, заказы и управление файлами. Этот соединитель Независимого издателя обеспечивает безопасную интеграцию с REST API Lexware, позволяя пользователям создавать бизнес-данные, автоматизировать процессы и подключать ресурсы Lexware с приложениями Power Platform. Соединитель использует поток кода авторизации OAuth 2.0 для безопасной проверки подлинности и рекомендаций по API.

Этот соединитель доступен в следующих продуктах и регионах:

Услуга	Class	Регионы
Copilot Studio	Премия	Все регионы Power Automate , кроме следующих:      - Правительство США (GCC)      - Правительство США (GCC High)      — Облако Китая, управляемое 21Vianet      - Министерство обороны США (DoD)
Логические приложения	Стандарт	Все регионы Logic Apps , кроме следующих:      — Регионы Azure для государственных организаций      — Регионы Azure Для Китая      - Министерство обороны США (DoD)
Power Apps	Премия	Все регионы Power Apps , кроме следующих:      - Правительство США (GCC)      - Правительство США (GCC High)      — Облако Китая, управляемое 21Vianet      - Министерство обороны США (DoD)
Power Automate	Премия	Все регионы Power Automate , кроме следующих:      - Правительство США (GCC)      - Правительство США (GCC High)      — Облако Китая, управляемое 21Vianet      - Министерство обороны США (DoD)

Контакт
Имя	Поддержка следователя LowCode
URL	https://lowcode-investigator.com/
Адрес электронной почты	kontakt@lowcodeinvestigator.com

Метаданные соединителя
Publisher	LowCodeInvestigator
Веб-узел	https://office.lexware.de/
Политика конфиденциальности	https://office.lexware.de/datenschutz/
Категории	Управление бизнесом; Финансировать

Соединитель API Lexware (независимый издатель)

API Lexware — это интерфейс RESTful, позволяющий разработчикам интегрировать бизнес-функции Lexware, такие как контакты, счета, статьи и файлы в собственные приложения. Этот соединитель обеспечивает прямое взаимодействие с этими ресурсами с помощью защищенных запросов API, прошедших проверку подлинности.

Издатель: независимый издатель

Предпосылки

• Зарегистрированная учетная запись Lexware и соответствующая лицензия
• Допустимый ключ API (маркер доступа), полученный с помощью портала разработчика Lexware
• Поток кода авторизации OAuth 2.0 необходим для проверки подлинности

Поддерживаемые операции

Этот соединитель поддерживает следующие конечные точки API Lexware:

• Статьи: создание, извлечение, обновление, удаление и фильтрация статей
• Контакты: управление данными клиента и поставщика
• Счета: создание и получение данных счета, включая отображение PDF-файлов
• Кредитные заметки, заметки о доставке, заказы, кавычки и ваучеры
• Страны, условия оплаты, макеты печати и профили
• Подписки на события и файлы
• Полный список, приведенный в документе: Документация по API Lexware

Получение учетных данных

Чтобы вызвать API Lexware, вам нужен ключ API:

1. Войдите в учетную запись Lexware Office.
2. Перейдите к расширениям → Weitere Apps → общедоступным API или откройте
   Портал разработчика Lexware напрямую.
3. Создайте новый ключ API с требуемыми разрешениями.
4. Скопируйте созданный ключ API. Это значение будет использоваться как accessToken в соединителе.

Шлюз API

Используйте новый шлюз API Lexware:

https://api.lexware.io

Ограничения скорости

• Максимальное количество запросов в секунду
• Запросы, превышающие это ограничение, получают HTTP 429 Too Many Requests
• Рекомендуется: использовать алгоритм контейнера маркеров или экспоненциальный обратный выход

Authentication

API Lexware использует поток кода авторизации OAuth 2.0. Включите маркер в Authorization: Bearer {accessToken} заголовок каждого запроса.

Пример использования

Создание статьи:

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
    }
  }'

Известные проблемы и ограничения

• Максимальное количество запросов в секунду
• Для некоторых конечных точек требуются дополнительные разрешения или роли

Документация по API

Полный справочник по API доступен по адресу:
https://developers.lexware.io/docs/

Создание подключения

Соединитель поддерживает следующие типы проверки подлинности:

По умолчанию	Параметры для создания подключения.	Все регионы	Недоступен для совместного использования

По умолчанию

Применимо: все регионы

Параметры для создания подключения.

Это недоступно для общего доступа. Если приложение power предоставляется другому пользователю, пользователю будет предложено явно создать новое подключение.

Имя	Тип	Description	Обязательно
Ключ API	securestring	Ключ API для этого API	True

Ограничения на регулирование

Имя	Звонки	Период продления
Вызовы API для каждого подключения	100	60 секунд

Действия

Обновление ваучера	Обновление ваучера
Обновление контакта	Обновление контакта
Обновление статьи	Обновите существующую статью с идентификатором {id} данными, указанными в полезных данных в формате JSON. Возвращает результат действия по успешному выполнению.
Отображение документа заметки о доставке (PDF)	Эта конечная точка предоставляет доступ на чтение и запись к заметкам о доставке, а также возможность отрисовки документа в виде PDF-файла, чтобы скачать его. Заметки о доставке всегда создаются в режиме черновика и не должны быть завершены.
Отображение документа кредитной заметки (PDF)	Чтобы скачать pdf-файл документа кредитной заметки, вам потребуется его documentFileId. Этот идентификатор обычно возвращается ресурсом кредитной заметки. Однако недавно созданные кредитные заметки в состоянии открыты через API должны активировать отрисовку pdf-файла документа отдельно. Это можно сделать с этой конечной точкой.
Отображение документа подтверждения заказа (PDF)	Чтобы скачать pdf-файл документа подтверждения заказа, вам потребуется его documentFileId. Этот идентификатор обычно возвращается ресурсом подтверждения заказа. Однако только что созданные подтверждения заказа через API должны активировать отрисовку pdf-файла документа отдельно. Это можно сделать с этой конечной точкой.
Отображение документа счета (PDF)	Чтобы скачать pdf-файл документа счета, необходимо его documentFileId. Этот идентификатор обычно возвращается ресурсом счета. Однако только что созданные счета в состоянии открыты через API должны активировать отрисовку pdf-файла документа отдельно. Это можно сделать с этой конечной точкой.
Отправка файла	Используйте эту конечную точку для отправки файлов, например ваучеров или счетов.
Отправка файла в ваучер	Отправьте и назначьте файлы (pdf или изображение) в ваучер, определяемый {id}.
Отрисовка кавычки (PDF)	Чтобы скачать pdf-файл кавычки документа, необходимо его documentFileId. Обычно этот идентификатор возвращается ресурсом кавычки. Однако вновь созданные кавычки в состоянии, открытые через API, должны активировать отрисовку pdf-файла документа отдельно. Это можно сделать с этой конечной точкой.
Отрисовка подземного документа (PDF)	Чтобы скачать pdf-файл документа dunning, вам потребуется его documentFileId. Этот идентификатор обычно возвращается ресурсом dunning. Однако недавно созданные дюннинги через API должны активировать отрисовку pdf-файла документа отдельно. Это можно сделать с этой конечной точкой.
Получение ваучера	Вывод списка ваучеров на продажу (например, счета, кредитные сноски)
Получение всех контактов	Получение всех контактов
Получение всех повторяющихся шаблонов	Получение коллекции повторяющихся шаблонов. Результат возвращает только часть наиболее релевантных данных, на которые ссылается контакт (только идентификатор и имя), общая цена, условия оплаты и полные параметры повторяющихся шаблонов. Однако именование объектов и свойств совпадает.
Получение всех подписок на события	Получение всех подписок на события
Получение заметки о доставке	Возвращает заметку о доставке с значением идентификатора {id}.
Получение и фильтрация списка ваучеров	Получение ваучеров (книжных счетов) (например, salesinvoices, salescreditnotes), счетов (включая выставление счетов за вычетные платежи), кредитные заметки, подтверждения заказа, кавычки и заметки о доставке.
Получение кавычки	Возвращает кавычки с значением идентификатора {id}. Отрисовка кавычки (PDF)
Получение контакта	Получение контакта по идентификатору
Получение кредитной заметки	Эта конечная точка предоставляет доступ на чтение и запись к кредитным заметкам, а также возможность отрисовки документа в виде PDF-файла, чтобы скачать его. Кредитные заметки можно создавать в виде черновика или завершения в открытом режиме.
Получение повторяющегося шаблона	Возвращает повторяющийся шаблон с значением идентификатора {id}.
Получение подземления	Возвращает дюнение с значением идентификатора {id}.
Получение подписки на события	Получение подписки на события
Получение подтверждения заказа	Возвращает подтверждение заказа с значением идентификатора {id}.
Получение сведений о профиле	В следующем примере показано, как получить основные сведения о профиле. Перед отправкой запроса необходимо заменить заполнитель {accessToken}.
Получение сведений об оплате	Конечная точка оплаты предоставляет доступ на чтение к статусу оплаты (выставление счетов или продаж), включая счета и кредитные заметки.
Получение списка категорий публикации	Эта конечная точка предоставляет доступ на чтение к списку категорий публикации для ваучеров (бухгалтерия) доходов или расходов, которые поддерживаются в lexoffice.
Получение списка стран	Список стран, известных lexoffice.
Получение списка условий оплаты	В следующем примере показано, как получить список настроенных в настоящее время условий оплаты. Перед отправкой запроса необходимо заменить заполнитель {accessToken}.
Получение статьи	Возвращает статью с значением идентификатора {id}.
Получение счета	Возвращает счет с значением идентификатора {id}.
Получение счета по оплате вниз	Возвращает счет по нижнему платежу с значением идентификатора {id}.
Скачивание файла	Используйте эту конечную точку для скачивания файлов.
Создание ваучера	Создание ваучеров (ограничено ваучерами на продажу)
Создание дюн	Созданный дюн не будет отображаться в основном списке ваучеров в lexoffice, но будет прикреплен к счету и будет отображаться там. Чтобы предоставить клиентам доступ к созданному дюню, используйте нашу функцию глубокой связи.
Создание заметки о доставке	Созданная заметка о доставке будет отображаться в основном списке ваучеров в lexoffice. Заметки о доставке, передаваемые через API, создаются только в режиме черновика.
Создание кавычки	Кавычки, передаваемые через API, создаются в режиме черновика по умолчанию. Чтобы создать завершенные кавычки с состоянием, необходимо задать необязательный параметр запроса. Состояние кавычки нельзя изменить через API.
Создание контакта	Создание нового контакта
Создание кредитной заметки	Кредитные заметки, передаваемые через API, создаются в режиме черновика по умолчанию. Чтобы создать завершенную кредитную заметку с состоянием, необходимо задать необязательный параметр запроса. Состояние кредитной заметки нельзя изменить с помощью API
Создание подтверждения заказа	Эта конечная точка предоставляет доступ на чтение и запись для подтверждения заказа, а также возможность отрисовки документа в виде PDF-файла, чтобы скачать его. Подтверждения заказов всегда создаются в режиме черновика и не должны быть завершены.
Создание статьи	Содержимое статьи ожидается в тексте запроса в виде приложения или json.
Создание счета	Счета, передаваемые через API, создаются в режиме черновика по умолчанию. Чтобы создать завершенный счет с состоянием, необходимо задать необязательный параметр запроса. Состояние счета невозможно изменить через API.
Удаление Event-Subscription	Удаление веб-перехватчика триггера
Удаление статьи	Удаляет статью с значением идентификатора {id}. Возвращает значение 204 при успешном выполнении или 404, если идентификатор не существует.
Фильтрация статей	Возвращает статьи, которые соответствуют критериям, заданным фильтрами, filter_1 filter_n с помощью механизма разбиения по страницам. Если задано несколько фильтров, логический соединитель имеет значение AND. Фильтры, которые не заданы, игнорируются. Чтобы проверить максимальный размер страницы для этой конечной точки, см. раздел "Разбиение по страницам ресурсов".

Обновление ваучера

ID операции:

UpdateVoucher

Обновление ваучера

Параметры

Имя	Ключ	Обязательно	Тип	Описание
Идентификатор	id	True	string	Укажите идентификатор.
contactId	contactId		string
dueDate	dueDate		date
files	files		array of string	список опущений fileIds
замечание	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
ваучерdate	voucherDate		date
количество	amount		float
categoryId	categoryId		string
taxAmount	taxAmount		float
taxRatePercent	taxRatePercent		integer
номер ваучера	voucherNumber		string
ваучерStatus	voucherStatus		string

Возвращает

Тело

Response_vouchers_id_put

Обновление контакта

ID операции:

UpdateContact

Обновление контакта

Параметры

Имя	Ключ	Обязательно	Тип	Описание
Идентификатор	id	True	string	Укажите идентификатор.

Возвращает

Тело

Response_contacts_id_put

Обновление статьи

ID операции:

UpdateAnArticle

Обновите существующую статью с идентификатором {id} данными, указанными в полезных данных в формате JSON. Возвращает результат действия по успешному выполнению.

Параметры

Имя	Ключ	Обязательно	Тип	Описание
Идентификатор	id	True	string	Укажите идентификатор.
articleNumber	articleNumber		string	articleNumber
gtin	gtin		string	gtin
Примечание	note		string	Примечание
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

Возвращает

Тело

Response_articles_id_get

Отображение документа заметки о доставке (PDF)

ID операции:

RenderDeliveryNoteDocument

Эта конечная точка предоставляет доступ на чтение и запись к заметкам о доставке, а также возможность отрисовки документа в виде PDF-файла, чтобы скачать его. Заметки о доставке всегда создаются в режиме черновика и не должны быть завершены.

Параметры

Имя	Ключ	Обязательно	Тип	Описание
Заметка о доставке	DeliveryNoteid	True	string	Укажите заметку о доставке.

Возвращает

Имя	Путь	Тип	Описание
city	address.city	string
countryCode	address.countryCode	string
имя	address.name	string
улица	address.street	string
Дополнение	address.supplement	string
ZIP-архив	address.zip	string
Архив	archived	boolean
дата создания	createdDate	date-time
deliveryTerms	deliveryTerms	string
id	id	uuid
Знакомство	introduction	string
language	language	string
элементы строки	lineItems	array of object
имя	lineItems.name	string
количество	lineItems.quantity	number
type	lineItems.type	string
unitName	lineItems.unitName	string
currency	lineItems.unitPrice.currency	string
grossAmount	lineItems.unitPrice.grossAmount	float
netAmount	lineItems.unitPrice.netAmount	float
taxRatePercentage	lineItems.unitPrice.taxRatePercentage	number
organizationId	organizationId	uuid
замечание	remark	string
taxType	taxConditions.taxType	string
title	title	string
обновленная дата	updatedDate	date-time
version	version	integer
ваучерdate	voucherDate	date-time
номер ваучера	voucherNumber	string
ваучерStatus	voucherStatus	string

Отображение документа кредитной заметки (PDF)

ID операции:

RenderCreditNoteDocument

Чтобы скачать pdf-файл документа кредитной заметки, вам потребуется его documentFileId. Этот идентификатор обычно возвращается ресурсом кредитной заметки. Однако недавно созданные кредитные заметки в состоянии открыты через API должны активировать отрисовку pdf-файла документа отдельно. Это можно сделать с этой конечной точкой.

Параметры

Имя	Ключ	Обязательно	Тип	Описание
Идентификатор	id	True	string	Укажите идентификатор.

Возвращает

Имя	Путь	Тип	Описание
documentFileId	documentFileId	uuid

Отображение документа подтверждения заказа (PDF)

ID операции:

RenderOrderConfirmationDocument

Чтобы скачать pdf-файл документа подтверждения заказа, вам потребуется его documentFileId. Этот идентификатор обычно возвращается ресурсом подтверждения заказа. Однако только что созданные подтверждения заказа через API должны активировать отрисовку pdf-файла документа отдельно. Это можно сделать с этой конечной точкой.

Параметры

Имя	Ключ	Обязательно	Тип	Описание
Идентификатор	id	True	string	Укажите идентификатор.

Возвращает

Имя	Путь	Тип	Описание
documentFileId	documentFileId	uuid

Отображение документа счета (PDF)

ID операции:

RenderInvoiceDocument

Чтобы скачать pdf-файл документа счета, необходимо его documentFileId. Этот идентификатор обычно возвращается ресурсом счета. Однако только что созданные счета в состоянии открыты через API должны активировать отрисовку pdf-файла документа отдельно. Это можно сделать с этой конечной точкой.

Параметры

Имя	Ключ	Обязательно	Тип	Описание
Идентификатор	id	True	string	Укажите идентификатор.

Возвращает

Имя	Путь	Тип	Описание
documentFileId	documentFileId	uuid

Отправка файла

ID операции:

UploadFile_Lexoffice

Используйте эту конечную точку для отправки файлов, например ваучеров или счетов.

Параметры

Имя	Ключ	Обязательно	Тип	Описание
Файл	file	True	file	Файл для отправки.
Тип	type	True	string	Описание содержимого файла.

Возвращает

Тело

Response_files_post

Отправка файла в ваучер

ID операции:

UploadFileVoucher_Lexoffice

Отправьте и назначьте файлы (pdf или изображение) в ваучер, определяемый {id}.

Параметры

Имя	Ключ	Обязательно	Тип	Описание
Идентификатор	id	True	string	Укажите идентификатор.
Файл	file	True	file	Файл для отправки.

Отрисовка кавычки (PDF)

ID операции:

RenderQuotationDocument

Чтобы скачать pdf-файл кавычки документа, необходимо его documentFileId. Обычно этот идентификатор возвращается ресурсом кавычки. Однако вновь созданные кавычки в состоянии, открытые через API, должны активировать отрисовку pdf-файла документа отдельно. Это можно сделать с этой конечной точкой.

Параметры

Имя	Ключ	Обязательно	Тип	Описание
Идентификатор	id	True	string	Укажите идентификатор.

Возвращает

Имя	Путь	Тип	Описание
documentFileId	documentFileId	uuid

Отрисовка подземного документа (PDF)

ID операции:

RenderDunningDocument

Чтобы скачать pdf-файл документа dunning, вам потребуется его documentFileId. Этот идентификатор обычно возвращается ресурсом dunning. Однако недавно созданные дюннинги через API должны активировать отрисовку pdf-файла документа отдельно. Это можно сделать с этой конечной точкой.

Параметры

Имя	Ключ	Обязательно	Тип	Описание
Dunningsid	dunningsid	True	string	Укажите dunningsid.

Возвращает

Имя	Путь	Тип	Описание
documentFileId	documentFileId	uuid

Получение ваучера

ID операции:

RetrieveVoucher

Вывод списка ваучеров на продажу (например, счета, кредитные сноски)

Параметры

Имя	Ключ	Обязательно	Тип	Описание
Идентификатор	id	True	string	Укажите идентификатор.

Возвращает

Имя	Путь	Тип	Описание
дата создания	createdDate	date-time
dueDate	dueDate	date-time
files	files	array of string
id	id	uuid
organizationId	organizationId	uuid
замечание	remark	string
shippingDate	shippingDate	date-time
taxType	taxType	string
totalGrossAmount	totalGrossAmount	number
totalTaxAmount	totalTaxAmount	number
type	type	string
обновленная дата	updatedDate	date-time
useCollectiveContact	useCollectiveContact	boolean
version	version	integer
ваучерdate	voucherDate	date-time
ваучерItems	voucherItems	array of object
количество	voucherItems.amount	number
categoryId	voucherItems.categoryId	uuid
taxAmount	voucherItems.taxAmount	number
taxRatePercent	voucherItems.taxRatePercent	number
номер ваучера	voucherNumber	string
ваучерStatus	voucherStatus	string

Получение всех контактов

ID операции:

RetrieveAllContacts

Получение всех контактов

Параметры

Имя	Ключ	Обязательно	Тип	Описание
Number	number		integer	Укажите номер.
Адрес электронной почты	email		string	Укажите сообщение электронной почты.
Имя	name		string	Укажите имя.
Поставщик	vendor		boolean	Укажите поставщика.
Клиент	customer		boolean	Укажите клиента.
Страница	page		integer	Укажите страницу.
Size	size		integer	Укажите размер.
Сортировать	sort		string	Укажите сортировку.

Возвращает

Тело

Response_contacts_get

Получение всех повторяющихся шаблонов

ID операции:

RetrieveAllRecurringTemplates

Получение коллекции повторяющихся шаблонов. Результат возвращает только часть наиболее релевантных данных, на которые ссылается контакт (только идентификатор и имя), общая цена, условия оплаты и полные параметры повторяющихся шаблонов. Однако именование объектов и свойств совпадает.

Параметры

Имя	Ключ	Обязательно	Тип	Описание
Страница	page		integer	Укажите страницу.
Size	size		integer	Укажите размер.
Сортировать	sort		string	Укажите сортировку.

Возвращает

Тело

Response_recurring-templates_get

Получение всех подписок на события

ID операции:

RetrieveAllEventSubscriptions

Получение всех подписок на события

Возвращает

Тело

Response_event-subscriptions_get

Получение заметки о доставке

ID операции:

RetrieveDeliveryNote

Возвращает заметку о доставке с значением идентификатора {id}.

Параметры

Имя	Ключ	Обязательно	Тип	Описание
Идентификатор	id	True	string	Укажите идентификатор.

Возвращает

Имя	Путь	Тип	Описание
city	address.city	string
countryCode	address.countryCode	string
имя	address.name	string
улица	address.street	string
Дополнение	address.supplement	string
ZIP-архив	address.zip	string
Архив	archived	boolean
дата создания	createdDate	date-time
deliveryTerms	deliveryTerms	string
id	id	uuid
Знакомство	introduction	string
language	language	string
элементы строки	lineItems	array of object
имя	lineItems.name	string
количество	lineItems.quantity	number
type	lineItems.type	string
unitName	lineItems.unitName	string
currency	lineItems.unitPrice.currency	string
grossAmount	lineItems.unitPrice.grossAmount	number
netAmount	lineItems.unitPrice.netAmount	number
taxRatePercentage	lineItems.unitPrice.taxRatePercentage	number
organizationId	organizationId	uuid
замечание	remark	string
taxType	taxConditions.taxType	string
title	title	string
обновленная дата	updatedDate	date-time
version	version	integer
ваучерdate	voucherDate	date-time
номер ваучера	voucherNumber	string
ваучерStatus	voucherStatus	string

Получение и фильтрация списка ваучеров

ID операции:

RetrieveAndFilterVoucherlist

Получение ваучеров (книжных счетов) (например, salesinvoices, salescreditnotes), счетов (включая выставление счетов за вычетные платежи), кредитные заметки, подтверждения заказа, кавычки и заметки о доставке.

Параметры

Имя	Ключ	Обязательно	Тип	Описание
Тип ваучера	voucherType	True	string	Укажите тип ваучера.
Состояние ваучера	voucherStatus	True	string	Укажите состояние ваучера.
Archived	archived		boolean	Укажите архивированный файл.
Контактный номер	contactId		string	Укажите идентификатор контакта.
Дата ваучера из	voucherDateFrom		string	Укажите дату ваучера.
Дата ваучера до	voucherDateTo		string	Укажите дату ваучера.
Дата создания из	createdDateFrom		string	Укажите созданную дату из.
Дата создания	createdDateTo		string	Укажите дату создания.
Обновленная дата из	updatedDateFrom		string	Укажите обновленную дату из.
Дата обновления до	updatedDateTo		string	Укажите обновленную дату.
Номер ваучера	voucherNumber		string	Укажите номер ваучера.
Страница	page		integer	Укажите страницу.
Size	size		integer	Укажите размер.
Сортировать	sort		string	Укажите сортировку.

Возвращает

Тело

Response_voucherlist_get

Получение кавычки

ID операции:

RetrieveQuotation

Возвращает кавычки с значением идентификатора {id}. Отрисовка кавычки (PDF)

Параметры

Имя	Ключ	Обязательно	Тип	Описание
Идентификатор	id	True	string	Укажите идентификатор.

Возвращает

Имя	Путь	Тип	Описание
city	address.city	string
contactId	address.contactId	uuid
countryCode	address.countryCode	string
имя	address.name	string
улица	address.street	string
ZIP-архив	address.zip	string
Архив	archived	boolean
дата создания	createdDate	date-time
expirationDate	expirationDate	date-time
documentFileId	files.documentFileId	uuid
id	id	uuid
Знакомство	introduction	string
language	language	string
элементы строки	lineItems	array of object
альтернатива	lineItems.alternative	boolean
discountPercentage	lineItems.discountPercentage	number
id	lineItems.id	uuid
lineItemAmount	lineItems.lineItemAmount	number
имя	lineItems.name	string
optional	lineItems.optional	boolean
количество	lineItems.quantity	number
Подэлементов	lineItems.subItems	array of object
альтернатива	lineItems.subItems.alternative	boolean
discountPercentage	lineItems.subItems.discountPercentage	number
id	lineItems.subItems.id	uuid
lineItemAmount	lineItems.subItems.lineItemAmount	number
имя	lineItems.subItems.name	string
optional	lineItems.subItems.optional	boolean
количество	lineItems.subItems.quantity	number
type	lineItems.subItems.type	string
unitName	lineItems.subItems.unitName	string
currency	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
currency	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
замечание	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
currency	totalPrice.currency	string
totalGrossAmount	totalPrice.totalGrossAmount	number
totalNetAmount	totalPrice.totalNetAmount	number
totalTaxAmount	totalPrice.totalTaxAmount	number
обновленная дата	updatedDate	date-time
version	version	integer
ваучерdate	voucherDate	date-time
номер ваучера	voucherNumber	string
ваучерStatus	voucherStatus	string

Получение контакта

ID операции:

RetrieveContact

Получение контакта по идентификатору

Параметры

Имя	Ключ	Обязательно	Тип	Описание
Идентификатор	id	True	string	Укажите идентификатор.

Возвращает

Имя	Путь	Тип	Описание
Архив	archived	boolean
id	id	string
organizationId	organizationId	string
Имя	person.firstName	string
lastName	person.lastName	string
приветствие	person.salutation	string
число/номер	roles.customer.number	integer
version	version	integer

Получение кредитной заметки

ID операции:

RetrieveCreditNote

Эта конечная точка предоставляет доступ на чтение и запись к кредитным заметкам, а также возможность отрисовки документа в виде PDF-файла, чтобы скачать его. Кредитные заметки можно создавать в виде черновика или завершения в открытом режиме.

Параметры

Имя	Ключ	Обязательно	Тип	Описание
Идентификатор	id	True	string	Укажите идентификатор.

Возвращает

Имя	Путь	Тип	Описание
city	address.city	string
countryCode	address.countryCode	string
имя	address.name	string
улица	address.street	string
Дополнение	address.supplement	string
ZIP-архив	address.zip	string
Архив	archived	boolean
дата создания	createdDate	date-time
id	id	uuid
Знакомство	introduction	string
language	language	string
элементы строки	lineItems	array of object
lineItemAmount	lineItems.lineItemAmount	number
имя	lineItems.name	string
количество	lineItems.quantity	number
type	lineItems.type	string
unitName	lineItems.unitName	string
currency	lineItems.unitPrice.currency	string
grossAmount	lineItems.unitPrice.grossAmount	float
netAmount	lineItems.unitPrice.netAmount	float
taxRatePercentage	lineItems.unitPrice.taxRatePercentage	number
organizationId	organizationId	uuid
замечание	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
currency	totalPrice.currency	string
totalGrossAmount	totalPrice.totalGrossAmount	float
totalNetAmount	totalPrice.totalNetAmount	float
totalTaxAmount	totalPrice.totalTaxAmount	float
обновленная дата	updatedDate	date-time
version	version	integer
ваучерdate	voucherDate	date-time
номер ваучера	voucherNumber	string
ваучерStatus	voucherStatus	string

Получение повторяющегося шаблона

ID операции:

RetrieveRecurringTemplate

Возвращает повторяющийся шаблон с значением идентификатора {id}.

Параметры

Имя	Ключ	Обязательно	Тип	Описание
Идентификатор	id	True	string	Укажите идентификатор.

Возвращает

Имя	Путь	Тип	Описание
city	address.city	string
contactId	address.contactId	uuid
countryCode	address.countryCode	string
имя	address.name	string
улица	address.street	string
ZIP-архив	address.zip	string
Архив	archived	boolean
дата создания	createdDate	date-time
id	id	uuid
Знакомство	introduction	string
language	language	string
элементы строки	lineItems	array of object
discountPercentage	lineItems.discountPercentage	number
lineItemAmount	lineItems.lineItemAmount	number
имя	lineItems.name	string
количество	lineItems.quantity	number
type	lineItems.type	string
unitName	lineItems.unitName	string
currency	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
повторяющиеся наборыTemplateSettings	recurringTemplateSettings	object
замечание	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
currency	totalPrice.currency	string
totalGrossAmount	totalPrice.totalGrossAmount	number
totalNetAmount	totalPrice.totalNetAmount	number
totalTaxAmount	totalPrice.totalTaxAmount	number
обновленная дата	updatedDate	date-time
version	version	integer

Получение подземления

ID операции:

RetrieveDunning

Возвращает дюнение с значением идентификатора {id}.

Параметры

Имя	Ключ	Обязательно	Тип	Описание
Dunningsid	dunningsid	True	string	Укажите dunningsid.

Возвращает

Имя	Путь	Тип	Описание
city	address.city	string
countryCode	address.countryCode	string
имя	address.name	string
улица	address.street	string
Дополнение	address.supplement	string
ZIP-архив	address.zip	string
Архив	archived	boolean
дата создания	createdDate	date-time
id	id	uuid
Знакомство	introduction	string
language	language	string
элементы строки	lineItems	array of object
discountPercentage	lineItems.discountPercentage	number
lineItemAmount	lineItems.lineItemAmount	number
имя	lineItems.name	string
количество	lineItems.quantity	number
type	lineItems.type	string
unitName	lineItems.unitName	string
currency	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
номер ваучера	relatedVouchers.voucherNumber	string
ваучерТип	relatedVouchers.voucherType	string
замечание	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
currency	totalPrice.currency	string
totalGrossAmount	totalPrice.totalGrossAmount	number
totalNetAmount	totalPrice.totalNetAmount	number
totalTaxAmount	totalPrice.totalTaxAmount	number
обновленная дата	updatedDate	date-time
version	version	integer
ваучерdate	voucherDate	date-time
ваучерStatus	voucherStatus	string

Получение подписки на события

ID операции:

RetrieveAEventSubscription

Получение подписки на события

Параметры

Имя	Ключ	Обязательно	Тип	Описание
идентификатор подписки;	subscriptionId	True	string	Укажите идентификатор подписки.

Возвращает

Тело

EventSubscriptionResponse

Получение подтверждения заказа

ID операции:

RetrieveOrderConfirmation

Возвращает подтверждение заказа с значением идентификатора {id}.

Параметры

Имя	Ключ	Обязательно	Тип	Описание
Идентификатор	id	True	string	Укажите идентификатор.

Возвращает

Имя	Путь	Тип	Описание
city	address.city	string
countryCode	address.countryCode	string
имя	address.name	string
улица	address.street	string
Дополнение	address.supplement	string
ZIP-архив	address.zip	string
Архив	archived	boolean
дата создания	createdDate	date-time
deliveryTerms	deliveryTerms	string
documentFileId	files.documentFileId	uuid
id	id	uuid
Знакомство	introduction	string
language	language	string
элементы строки	lineItems	array of object
discountPercentage	lineItems.discountPercentage	number
id	lineItems.id	uuid
lineItemAmount	lineItems.lineItemAmount	number
имя	lineItems.name	string
количество	lineItems.quantity	number
type	lineItems.type	string
unitName	lineItems.unitName	string
currency	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
замечание	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
currency	totalPrice.currency	string
totalGrossAmount	totalPrice.totalGrossAmount	number
totalNetAmount	totalPrice.totalNetAmount	number
totalTaxAmount	totalPrice.totalTaxAmount	number
обновленная дата	updatedDate	date-time
version	version	integer
ваучерdate	voucherDate	date-time
номер ваучера	voucherNumber	string
ваучерStatus	voucherStatus	string

Получение сведений о профиле

ID операции:

RetrieveProfileInformation

В следующем примере показано, как получить основные сведения о профиле. Перед отправкой запроса необходимо заменить заполнитель {accessToken}.

Возвращает

Тело

Response_profile_get

Получение сведений об оплате

ID операции:

RetrievePaymentInformation

Конечная точка оплаты предоставляет доступ на чтение к статусу оплаты (выставление счетов или продаж), включая счета и кредитные заметки.

Параметры

Имя	Ключ	Обязательно	Тип	Описание
Идентификатор ваучера	voucherId	True	string	Укажите идентификатор ваучера.

Возвращает

Имя	Путь	Тип	Описание
currency	currency	string
openAmount	openAmount	string
paymentItems	paymentItems	array of object
количество	paymentItems.amount	float
currency	paymentItems.currency	string
paymentItemType	paymentItems.paymentItemType	string
postingDate	paymentItems.postingDate	date-time
статус платежа	paymentStatus	string
ваучерStatus	voucherStatus	string
ваучерТип	voucherType	string

Получение списка категорий публикации

ID операции:

RetrieveListPostingCategories

Эта конечная точка предоставляет доступ на чтение к списку категорий публикации для ваучеров (бухгалтерия) доходов или расходов, которые поддерживаются в lexoffice.

Возвращает

response

array of Response_posting-categories_get_items

Получение списка стран

ID операции:

RetrieveListCountries

Список стран, известных lexoffice.

Возвращает

response

array of Response_countries_get_default

Получение списка условий оплаты

ID операции:

RetrieveListOfPaymentConditions

В следующем примере показано, как получить список настроенных в настоящее время условий оплаты. Перед отправкой запроса необходимо заменить заполнитель {accessToken}.

Возвращает

response

array of Response_payment-conditions_get_items

Получение статьи

ID операции:

RetrieveAnArticle

Возвращает статью с значением идентификатора {id}.

Параметры

Имя	Ключ	Обязательно	Тип	Описание
Идентификатор	id	True	string	Укажите идентификатор.

Возвращает

Имя	Путь	Тип	Описание
articleNumber	articleNumber	string
gtin	gtin	string
id	id	string
Примечание	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

Получение счета

ID операции:

RetrieveInvoice

Возвращает счет с значением идентификатора {id}.

Параметры

Имя	Ключ	Обязательно	Тип	Описание
Идентификатор	id	True	string	Укажите идентификатор.

Возвращает

Имя	Путь	Тип	Описание
city	address.city	string
countryCode	address.countryCode	string
имя	address.name	string
улица	address.street	string
Дополнение	address.supplement	string
ZIP-архив	address.zip	string
Архив	archived	boolean
дата создания	createdDate	date-time
id	id	uuid
Знакомство	introduction	string
language	language	string
элементы строки	lineItems	array of object
discountPercentage	lineItems.discountPercentage	number
id	lineItems.id	uuid
lineItemAmount	lineItems.lineItemAmount	number
имя	lineItems.name	string
количество	lineItems.quantity	number
type	lineItems.type	string
unitName	lineItems.unitName	string
currency	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
замечание	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
currency	totalPrice.currency	string
totalGrossAmount	totalPrice.totalGrossAmount	number
totalNetAmount	totalPrice.totalNetAmount	number
totalTaxAmount	totalPrice.totalTaxAmount	number
обновленная дата	updatedDate	date-time
version	version	integer
ваучерdate	voucherDate	date-time
номер ваучера	voucherNumber	string
ваучерStatus	voucherStatus	string

Получение счета по оплате вниз

ID операции:

RetrieveDownPaymentInvoice

Возвращает счет по нижнему платежу с значением идентификатора {id}.

Параметры

Имя	Ключ	Обязательно	Тип	Описание
Идентификатор	id	True	string	Укажите идентификатор.

Возвращает

Имя	Путь	Тип	Описание
city	address.city	string
countryCode	address.countryCode	string
имя	address.name	string
улица	address.street	string
Дополнение	address.supplement	string
ZIP-архив	address.zip	string
Архив	archived	boolean
closingInvoiceId	closingInvoiceId	uuid
дата создания	createdDate	date-time
dueDate	dueDate	date-time
documentFileId	files.documentFileId	uuid
id	id	uuid
Знакомство	introduction	string
language	language	string
элементы строки	lineItems	array of object
lineItemAmount	lineItems.lineItemAmount	number
имя	lineItems.name	string
количество	lineItems.quantity	number
type	lineItems.type	string
currency	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
замечание	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
currency	totalPrice.currency	string
totalGrossAmount	totalPrice.totalGrossAmount	number
totalNetAmount	totalPrice.totalNetAmount	number
totalTaxAmount	totalPrice.totalTaxAmount	number
обновленная дата	updatedDate	date-time
version	version	integer
ваучерdate	voucherDate	date-time
номер ваучера	voucherNumber	string
ваучерStatus	voucherStatus	string

Скачивание файла

ID операции:

DownloadFile_Lexoffice

Используйте эту конечную точку для скачивания файлов.

Параметры

Имя	Ключ	Обязательно	Тип	Описание
Идентификатор файла	fileId	True	string	Укажите идентификатор файла.
Принять	Accept		string	Укажите принятие.

Возвращает

response

file

Создание ваучера

ID операции:

CreateVoucher

Создание ваучеров (ограничено ваучерами на продажу)

Параметры

Имя	Ключ	Обязательно	Тип	Описание
contactId	contactId		string
dueDate	dueDate		date
замечание	remark		string
shippingDate	shippingDate		date
taxType	taxType	True	string
totalGrossAmount	totalGrossAmount		float
totalTaxAmount	totalTaxAmount		float
type	type	True	string
useCollectiveContact	useCollectiveContact		boolean
ваучерdate	voucherDate		date
количество	amount		float
categoryId	categoryId		string
taxAmount	taxAmount		float
taxRatePercent	taxRatePercent		integer
номер ваучера	voucherNumber		string
ваучерStatus	voucherStatus		string

Возвращает

Тело

Response_vouchers_post

Создание дюн

ID операции:

CreateDunning

Созданный дюн не будет отображаться в основном списке ваучеров в lexoffice, но будет прикреплен к счету и будет отображаться там. Чтобы предоставить клиентам доступ к созданному дюню, используйте нашу функцию глубокой связи.

Параметры

Имя	Ключ	Обязательно	Тип	Описание
Предыдущий идентификатор ваучера продаж	precedingSalesVoucherId		string	Укажите предыдущий идентификатор ваучера на продажу.

Возвращает

Тело

Response_dunnings_post

Создание заметки о доставке

ID операции:

CreateDeliveryNote

Созданная заметка о доставке будет отображаться в основном списке ваучеров в lexoffice. Заметки о доставке, передаваемые через API, создаются только в режиме черновика.

Параметры

Имя	Ключ	Обязательно	Тип	Описание
Предыдущий идентификатор ваучера продаж	precedingSalesVoucherId		string	Укажите предыдущий идентификатор ваучера на продажу.

Возвращает

Тело

Response_delivery-notes_post

Создание кавычки

ID операции:

CreateQuotation

Кавычки, передаваемые через API, создаются в режиме черновика по умолчанию. Чтобы создать завершенные кавычки с состоянием, необходимо задать необязательный параметр запроса. Состояние кавычки нельзя изменить через API.

Параметры

Имя	Ключ	Обязательно	Тип	Описание
Финализировать	finalize	True	boolean	Укажите завершение.

Возвращает

Тело

Response_quotations_post

Создание контакта

ID операции:

CreateContact

Создание нового контакта

Возвращает

Тело

Response_contacts_post

Создание кредитной заметки

ID операции:

CreateCreditNote

Кредитные заметки, передаваемые через API, создаются в режиме черновика по умолчанию. Чтобы создать завершенную кредитную заметку с состоянием, необходимо задать необязательный параметр запроса. Состояние кредитной заметки нельзя изменить с помощью API

Параметры

Имя	Ключ	Обязательно	Тип	Описание
Предыдущий идентификатор ваучера продаж	precedingSalesVoucherId		string	Укажите предыдущий идентификатор ваучера на продажу.
Финализировать	finalize	True	boolean	Укажите завершение.

Возвращает

Тело

Response_credit-notes_post

Создание подтверждения заказа

ID операции:

CreateOrderConfirmation

Эта конечная точка предоставляет доступ на чтение и запись для подтверждения заказа, а также возможность отрисовки документа в виде PDF-файла, чтобы скачать его. Подтверждения заказов всегда создаются в режиме черновика и не должны быть завершены.

Параметры

Имя	Ключ	Обязательно	Тип	Описание
Предыдущий идентификатор ваучера продаж	precedingSalesVoucherId		string	Укажите предыдущий идентификатор ваучера на продажу.

Возвращает

Тело

Response_order-confirmations_post

Создание статьи

ID операции:

CreateArticle

Содержимое статьи ожидается в тексте запроса в виде приложения или json.

Параметры

Имя	Ключ	Обязательно	Тип	Описание
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

Возвращает

Тело

Response_articles_post

Создание счета

ID операции:

CreateInvoice

Счета, передаваемые через API, создаются в режиме черновика по умолчанию. Чтобы создать завершенный счет с состоянием, необходимо задать необязательный параметр запроса. Состояние счета невозможно изменить через API.

Параметры

Имя	Ключ	Обязательно	Тип	Описание
Предыдущий идентификатор ваучера продаж	precedingSalesVoucherId		string	Укажите предыдущий идентификатор ваучера на продажу.
Финализировать	finalize	True	boolean	Укажите завершение.

Возвращает

Тело

Response_invoices_post

Удаление Event-Subscription

ID операции:

DeleteEventSubscription

Удаление веб-перехватчика триггера

Параметры

Имя	Ключ	Обязательно	Тип	Описание
идентификатор подписки;	subscriptionId	True	string	Укажите идентификатор подписки.

Удаление статьи

ID операции:

DeleteAnArticle

Удаляет статью с значением идентификатора {id}. Возвращает значение 204 при успешном выполнении или 404, если идентификатор не существует.

Параметры

Имя	Ключ	Обязательно	Тип	Описание
Идентификатор	id	True	string	Укажите идентификатор.

Фильтрация статей

ID операции:

FilteringArticles

Возвращает статьи, которые соответствуют критериям, заданным фильтрами, filter_1 filter_n с помощью механизма разбиения по страницам. Если задано несколько фильтров, логический соединитель имеет значение AND. Фильтры, которые не заданы, игнорируются. Чтобы проверить максимальный размер страницы для этой конечной точки, см. раздел "Разбиение по страницам ресурсов".

Параметры

Имя	Ключ	Обязательно	Тип	Описание
Номер статьи	articleNumber		string	Укажите номер статьи.
Gtin	gtin		string	Укажите gtin.
Тип	type		string	Укажите тип.
Страница	page		integer	Укажите страницу.
Size	size		integer	Укажите размер.
Сортировать	sort		string	Укажите сортировку.

Возвращает

Тело

Response_articles_get

Триггеры

Выбор пользовательского триггера

Регистрация нового триггера для конечной точки контактов

Выбор пользовательского триггера

ID операции:

EventSubscription_Lexoffice

Регистрация нового триггера для конечной точки контактов

Параметры

Имя	Ключ	Обязательно	Тип	Описание
Тип события	eventType	True	string	eventType

Возвращает

Имя	Путь	Тип	Описание
eventDate	eventDate	string	eventDate
eventType	eventType	string	eventType
organizationId	organizationId	string	organizationId
resourceId	resourceId	string	resourceId

Определения

EventSubscriptionResponse

Имя	Путь	Тип	Описание
subscriptionId	subscriptionId	string
eventType	eventType	string
organizationId	organizationId	string
дата создания	createdDate	date-time
callbackUrl	callbackUrl	string

Response_articles_get

Имя	Путь	Тип	Описание
содержимое	content	array of object	содержимое
articleNumber	content.articleNumber	string	articleNumber
gtin	content.gtin	string	gtin
id	content.id	string	id
Примечание	content.note	string	Примечание
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
первый	first	boolean	первый
последний	last	boolean	последний
число/номер	number	integer	число/номер
numberOfElements	numberOfElements	integer	numberOfElements
size	size	integer	size
sort	sort	array of object	sort
по возрастанию	sort.ascending	boolean	по возрастанию
направление	sort.direction	string	направление
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

Имя	Путь	Тип	Описание
articleNumber	articleNumber	string	articleNumber
gtin	gtin	string	gtin
id	id	string	id
Примечание	note	string	Примечание
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

Имя	Путь	Тип	Описание
дата создания	createdDate	string	дата создания
id	id	string	id
resourceUri	resourceUri	string	resourceUri
обновленная дата	updatedDate	string	обновленная дата
version	version	integer	version

Response_contacts_get

Имя	Путь	Тип	Описание
содержимое	content	array of object	содержимое
Выставление счетов	content.addresses.billing	array of object	Выставление счетов
city	content.addresses.billing.city	string	city
countryCode	content.addresses.billing.countryCode	string	countryCode
улица	content.addresses.billing.street	string	улица
Дополнение	content.addresses.billing.supplement	string	Дополнение
ZIP-архив	content.addresses.billing.zip	string	ZIP-архив
судоходство	content.addresses.shipping	array of object	судоходство
city	content.addresses.shipping.city	string	city
countryCode	content.addresses.shipping.countryCode	string	countryCode
улица	content.addresses.shipping.street	string	улица
Дополнение	content.addresses.shipping.supplement	string	Дополнение
ZIP-архив	content.addresses.shipping.zip	string	ZIP-архив
Архив	content.archived	boolean	Архив
allowTaxFreeInvoices	content.company.allowTaxFreeInvoices	boolean	allowTaxFreeInvoices
contactPersons	content.company.contactPersons	array of object	contactPersons
адрес электронной почты	content.company.contactPersons.emailAddress	string	адрес электронной почты
Имя	content.company.contactPersons.firstName	string	Имя
lastName	content.company.contactPersons.lastName	string	lastName
основной	content.company.contactPersons.primary	boolean	основной
приветствие	content.company.contactPersons.salutation	string	приветствие
имя	content.company.name	string	имя
taxNumber	content.company.taxNumber	string	taxNumber
vatRegistrationId	content.company.vatRegistrationId	string	vatRegistrationId
Бизнес	content.emailAddresses.business	array of string	Бизнес
офис	content.emailAddresses.office	array of string	офис
other	content.emailAddresses.other	array of string	other
id	content.id	string	id
Примечание	content.note	string	Примечание
organizationId	content.organizationId	string	organizationId
Бизнес	content.phoneNumbers.business	array of string	Бизнес
fax	content.phoneNumbers.fax	array of string	fax
офис	content.phoneNumbers.office	array of string	офис
other	content.phoneNumbers.other	array of string	other
число/номер	content.roles.customer.number	integer	число/номер
число/номер	content.roles.vendor.number	integer	число/номер
version	content.version	integer	version
первый	first	boolean	первый
последний	last	boolean	последний
число/номер	number	integer	число/номер
numberOfElements	numberOfElements	integer	numberOfElements
size	size	integer	size
sort	sort	array of object	sort
по возрастанию	sort.ascending	boolean	по возрастанию
направление	sort.direction	string	направление
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

Имя	Путь	Тип	Описание
дата создания	createdDate	string	дата создания
id	id	string	id
resourceUri	resourceUri	string	resourceUri
обновленная дата	updatedDate	string	обновленная дата
version	version	integer	version

Response_countries_get_default

Имя	Путь	Тип	Описание
countryCode	countryCode	string	countryCode
countryNameDE	countryNameDE	string	countryNameDE
countryNameEN	countryNameEN	string	countryNameEN
taxClassification	taxClassification	string	taxClassification

Response_credit-notes_post

Имя	Путь	Тип	Описание
дата создания	createdDate	string	дата создания
id	id	string	id
resourceUri	resourceUri	string	resourceUri
обновленная дата	updatedDate	string	обновленная дата
version	version	integer	version

Response_delivery-notes_post

Имя	Путь	Тип	Описание
дата создания	createdDate	string	дата создания
id	id	string	id
resourceUri	resourceUri	string	resourceUri
обновленная дата	updatedDate	string	обновленная дата
version	version	integer	version

Response_dunnings_post

Имя	Путь	Тип	Описание
дата создания	createdDate	string	дата создания
id	id	string	id
resourceUri	resourceUri	string	resourceUri
обновленная дата	updatedDate	string	обновленная дата
version	version	integer	version

Response_event-subscriptions_get

Имя	Путь	Тип	Описание
содержимое	content	array of object	содержимое
callbackUrl	content.callbackUrl	string	callbackUrl
дата создания	content.createdDate	string	дата создания
eventType	content.eventType	string	eventType
organizationId	content.organizationId	string	organizationId
subscriptionId	content.subscriptionId	string	subscriptionId

Response_files_post

Имя	Путь	Тип	Описание
id	id	string	id

Response_invoices_post

Имя	Путь	Тип	Описание
дата создания	createdDate	string	дата создания
id	id	string	id
resourceUri	resourceUri	string	resourceUri
обновленная дата	updatedDate	string	обновленная дата
version	version	integer	version

Response_order-confirmations_post

Имя	Путь	Тип	Описание
дата создания	createdDate	string	дата создания
id	id	string	id
resourceUri	resourceUri	string	resourceUri
обновленная дата	updatedDate	string	обновленная дата
version	version	integer	version

Response_payment-conditions_get_items

Имя	Путь	Тип	Описание
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

Имя	Путь	Тип	Описание
contactRequired	contactRequired	boolean	contactRequired
groupName	groupName	string	groupName
id	id	string	id
имя	name	string	имя
splitAllowed	splitAllowed	boolean	splitAllowed
type	type	string	type

Response_profile_get

Имя	Путь	Тип	Описание
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
subscriptionStatus	subscriptionStatus	string	subscriptionStatus
taxType	taxType	string	taxType

Response_quotations_post

Имя	Путь	Тип	Описание
дата создания	createdDate	string	дата создания
id	id	string	id
resourceUri	resourceUri	string	resourceUri
обновленная дата	updatedDate	string	обновленная дата
version	version	integer	version

Response_recurring-templates_get

Имя	Путь	Тип	Описание
содержимое	content	array of object	содержимое
contactId	content.address.contactId	string	contactId
имя	content.address.name	string	имя
дата создания	content.createdDate	string	дата создания
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
Дата окончания	content.recurringTemplateSettings.endDate	string	Дата окончания
executionInterval	content.recurringTemplateSettings.executionInterval	string	executionInterval
executionStatus	content.recurringTemplateSettings.executionStatus	string	executionStatus
Завершить	content.recurringTemplateSettings.finalize	boolean	Завершить
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
currency	content.totalPrice.currency	string	currency
totalGrossAmount	content.totalPrice.totalGrossAmount	integer	totalGrossAmount
totalNetAmount	content.totalPrice.totalNetAmount	float	totalNetAmount
обновленная дата	content.updatedDate	string	обновленная дата
первый	first	boolean	первый
последний	last	boolean	последний
число/номер	number	integer	число/номер
numberOfElements	numberOfElements	integer	numberOfElements
size	size	integer	size
sort	sort	array of object	sort
по возрастанию	sort.ascending	boolean	по возрастанию
направление	sort.direction	string	направление
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

Имя	Путь	Тип	Описание
содержимое	content	array of object	содержимое
Архив	content.archived	boolean	Архив
contactId	content.contactId	string	contactId
contactName	content.contactName	string	contactName
дата создания	content.createdDate	string	дата создания
currency	content.currency	string	currency
dueDate	content.dueDate	string	dueDate
id	content.id	string	id
openAmount	content.openAmount	float	openAmount
общаяСумма	content.totalAmount	float	общаяСумма
обновленная дата	content.updatedDate	string	обновленная дата
ваучерdate	content.voucherDate	string	ваучерdate
номер ваучера	content.voucherNumber	string	номер ваучера
ваучерStatus	content.voucherStatus	string	ваучерStatus
ваучерТип	content.voucherType	string	ваучерТип
первый	first	boolean	первый
последний	last	boolean	последний
число/номер	number	integer	число/номер
numberOfElements	numberOfElements	integer	numberOfElements
size	size	integer	size
sort	sort	array of object	sort
по возрастанию	sort.ascending	boolean	по возрастанию
направление	sort.direction	string	направление
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

Имя	Путь	Тип	Описание
дата создания	createdDate	string	дата создания
id	id	string	id
resourceUri	resourceUri	string	resourceUri
обновленная дата	updatedDate	string	обновленная дата
version	version	integer	version

Response_contacts_id_put

Имя	Путь	Тип	Описание
Архив	archived	boolean
id	id	uuid
organizationId	organizationId	uuid
Имя	person.firstName	string
lastName	person.lastName	string
приветствие	person.salutation	string
число/номер	roles.customer.number	integer
version	version	integer

Response_vouchers_id_put

Имя	Путь	Тип	Описание
дата создания	createdDate	date-time
dueDate	dueDate	date-time
files	files	array of object
items	files	object
id	id	uuid
organizationId	organizationId	uuid
замечание	remark	string
shippingDate	shippingDate	date-time
taxType	taxType	string
totalGrossAmount	totalGrossAmount	number
totalTaxAmount	totalTaxAmount	number
type	type	string
обновленная дата	updatedDate	date-time
useCollectiveContact	useCollectiveContact	boolean
version	version	integer
ваучерdate	voucherDate	date-time
ваучерItems	voucherItems	array of object
количество	voucherItems.amount	number
categoryId	voucherItems.categoryId	uuid
taxAmount	voucherItems.taxAmount	number
taxRatePercent	voucherItems.taxRatePercent	number
номер ваучера	voucherNumber	string
ваучерStatus	voucherStatus	string

file

Это базовый тип данных file.