Lexoffice
The Lexoffice modules allow you to monitor, create, update, send, retrieve, upload, download, list, and download the documents, contacts, vouchers, and invoices in your Lexoffice account.
Getting Started with Lexoffice
Prerequisites
- A Lexoffice account – create a Lexoffice account at lexoffice.de/.
Connecting Lexoffice to Boost.space Integrator
To connect your Lexoffice account to Boost.space Integrator you need to obtain the API Key from your Lexoffice account and insert it in the Create a connection dialog in the Boost.space Integrator module.
1. Go to this API Key website and log in to your Lexoffice account.
2. Click Create key new > Accept the terms and conditions > Create keys.
3. Copy the API Key to your clipboard.
4. Go toBoost.space Integrator and open the Lexoffice module’s Create a connection dialog.
5. In the Connection name field, enter a name for the connection.
6. In the API Key field, enter the API key copied in step 3, and click Continue.
The connection has been established.
Event
Watch Events
Triggers when an event occurs are followed by the event type parameter.
You do not have to add the webhooks in the Lexoffice as it is automatically done for you once you add and save an instant trigger module to your scenario.
Webhook Name
Enter a name for the webhook.
Connection
Establish a connection to your Lexoffice account.
Event Type
Select or map the event types you want to watch. For example, Invoice Created.
Document
Upload a Document
Uploads a document for bookkeeping purposes.
Connection
Establish a connection to your Lexoffice account.
Filename
Enter (map) the filename with extension. For example, invoice.xml.
Data
Enter (map) file data.
Download a Document
Downloads a document.
Connection
Establish a connection to your Lexoffice account.
Document /File ID
Enter (map) the document ID or File ID you want to download.
Contact
Search Contacts
Searches for contacts by a filter parameter.
Connection
Establish a connection to your Lexoffice account.
Enter (map) the email address of the contact.
Name
Enter (map) the contact’s name.
Number
Enter (map) the contact’s phone number.
Customer
Select whether the contact is a customer to search for the customers that match the specified contact.
Vendor
Select whether the contact is a vendor to list the vendors that match the specified contact.
Limit
Set the maximum limit Boost.space Integrator should return during one execution cycle.
Get a Contact
Gets a specified contact.
Connection
Establish a connection to your Lexoffice account.
Contact ID
Select or map the Contact ID whose details you want to retrieve.
Create a Contact
Creates a new contact.
Connection
Establish a connection to your Lexoffice account.
Contact Type
Select or map the contact type:
-
Company
-
Person
Salutation
Enter (map) the contact’s salutation. For example, Mr.
Name
Enter (map) the company name.
First Name
Enter (map) the contact’s first name.
Last Name
Enter (map) the contact’s last name.
Tax Number
Enter (map) the contact’s or company’s registered tax number.
Allow Tax Free Invoices
Select whether you want to allow the tax-free invoices for the company or contact.
VAT Registration ID
Enter (map) the company’s VAT registration number.
Contact Persons
Add the contact persons of the company:
Salutation
Enter (map) the contact’s salutation. For example, Mr.
First Name
Enter (map) the contact’s first name.
Last Name
Enter (map) the contact’s last name.
Primary
Select whether this person is the primary contact of the company.
Email Address
Enter (map) the contact’s email address.
Phone Number
Enter (map) the contact’s phone number.
Roles
Select the contact or company roles. For example, vendor.
Addresses
Add the addresses of the contact or the company:
Type
Select or map the address type:
-
Billing
-
Shipping
Supplement
Enter (map) the add the contact name at the address.
Street
Enter (map) the street name.
Zip
Enter (map) the area zip code.
City
Enter (map) the city name.
Country Code
Enter (map) the country name.
Email Addresses
Add the email addresses of the contact or the company: Type Select or map the email address type. For example, business. Emails Enter (map) the email address of the contact.
Phone Numbers
Add the phone numbers of the contact or the company: Type Select or map the phone number type. For example, business. Emails Enter (map) the contact’s phone number.
Buyer Reference
Enter (map) the Customer’s Leitweg-ID conforming to the German XRechnung system.
Vendor Number At Customer
Your vendor number is used by the customer. This field is applicable when you are providing the Buyer Reference number.
Note
Enter (map) the additional information about the contact.
Update a contact
Updates an existing contact.
Connection
Establish a connection to your Lexoffice account.
Contact ID
Select or map the Contact ID whose details you want to update.
Contact Type
Select or map the contact type:
-
Company
-
Person
Salutation
Enter (map) the contact’s salutation. For example, Mr.
Name
Enter (map) the company name.
First Name
Enter (map) the contact’s first name.
Last Name
Enter (map) the contact’s last name.
Tax Number
Enter (map) the contact’s or company’s registered tax number.
Allow Tax Free Invoices
Select whether you want to allow the tax-free invoices for the company or contact.
VAT Registration ID
Enter (map) the company’s VAT registration number.
Contact Persons
Add the contact persons of the company:
Salutation
Enter (map) the contact’s salutation. For example, Mr.
First Name
Enter (map) the contact’s first name.
Last Name
Enter (map) the contact’s last name.
Primary
Select whether this person is the primary contact of the company.
Email Address
Enter (map) the contact’s email address.
Phone Number
Enter (map) the contact’s phone number.
Roles
Select the contact or company roles. For example, vendor.
Addresses
Add the addresses of the contact or the company:
Type
Select or map the address type:
-
Billing
-
Shipping
Supplement
Enter (map) the add the contact name at the address.
Street
Enter (map) the street name.
Zip
Enter (map) the area zip code.
City
Enter (map) the city name.
Country Code
Enter (map) the country name.
Email Addresses
Add the email addresses of the contact or the company: Type Select or map the email address type. For example, business. Emails Enter (map) the email address of the contact.
Phone Numbers
Add the phone numbers of the contact or the company: Type Select or map the phone number type. For example, business. Emails Enter (map) the contact’s phone number.
Buyer Reference
Enter (map) the Customer’s Leitweg-ID conforming to the German XRechnung system.
Vendor Number At Customer
Your vendor number is used by the customer. This field is applicable when you are providing the Buyer Reference number.
Note
Enter (map) the additional information about the contact.
Voucher
Search Voucher
Searches for vouchers with a voucher number.
Connection
Establish a connection to your Lexoffice account.
Voucher Number
Enter (map) the voucher number whose details you want to search.
Limit
Set the maximum number of vouchers Boost.space Integrator should return during one execution cycle.
List Voucher
Retrieves a list of vouchers.
Connection
Establish a connection to your Lexoffice account.
Voucher Type
Select or map the voucher type. For example, Invoice.
Voucher Status
Select or map the voucher status. For example, accepted.
Archive
Select whether you want to search the archived vouchers.
Sort
Select or map the option to sort the list the vouchers. For example, voucher date.
Limit
Set the maximum number of vouchers Boost.space Integrator should return during one execution cycle.
Create a Voucher
Creates a new voucher.
Connection
Establish a connection to your Lexoffice account.
Voucher Type
Select or map the voucher type. For example, Invoice.
Voucher Status
Select or map the voucher status. For example, accepted.
Archive
Select whether you want to search the archived vouchers.
Sort
Select or map the option to sort the list of vouchers.
Upload a File to a Voucher
Uploads a file and assigns it directly to a voucher.
Connection
Establish a connection to your Lexoffice account.
Voucher ID
Select or map the Voucher ID to which you want to upload a file.
File Name
Enter (map) the file name with extension. For example, invoice.xml.
Data
Enter (map) the file data.
Invoice
Get an Invoice
Gets a specified
Connection
Establish a connection to your Lexoffice account.
Invoice ID
Select or map Invoice ID whose details you want to retrieve.
Render an Invoice Document
Renders an invoice document to a file ID.
Connection
Establish a connection to your Lexoffice account.
Invoice ID
Select or map the document’s Invoice ID you want to render.
Other
Make an API Call
Performs an authorized arbitrary API call.
Connection
Establish a connection to your Lexoffice account.
URL
Enter a path relative to https://www.api.lexoffice.io. For example: /v1/contacts
For the list of available endpoints, refer to the Lexoffice API Documentation.
Method
Select the HTTP method you want to use:
-
GET – to retrieve information for an entry.
-
POST – to create a new entry.
-
PUT – to update/replace an existing entry.
-
PATCH – to make a partial entry update.
-
DELETE – to delete an entry.
Headers
Enter the desired request headers. You don’t have to add authorization headers; we already did that for you.
Query String
Enter the request query string.
Body
Enter the body content for your API call.
Example of Use – List Contacts
The following API call returns all the contacts from your Lexoffice account:
URL:
/v3/contacts
Method:
GET
Matches of the search can be found in the module’s Output under Bundle > Body > content.
In our example, 3 contacts were returned:
Legacy article, imported from the original Boost.space knowledge base (/knowledge-base/applications/commerce/lexoffice/).
