Commerce

Lexoffice

12min
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/ https //www lexoffice de/ connecting lexoffice to make to connect your lexoffice account to make you need to obtain the api key from your lexoffice account and insert it in the create a connection dialog in the make module 1\ go to this api key https //app lexoffice de/settings/#/public api 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 to make 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 lexoffice docid\ bryu8hm9xths2mzneikep 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 lexoffice docid\ bryu8hm9xths2mzneikep filename enter (map) the filename with extension for example, invoice xml data enter (map) file data download a document downloads a document connection lexoffice docid\ bryu8hm9xths2mzneikep 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 lexoffice docid\ bryu8hm9xths2mzneikep email 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 make should return during one execution cycle get a contact gets a specified contact connection lexoffice docid\ bryu8hm9xths2mzneikep contact id select or map the contact id whose details you want to retrieve create a contact creates a new contact connection lexoffice docid\ bryu8hm9xths2mzneikep 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 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 lexoffice docid\ bryu8hm9xths2mzneikep 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 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 lexoffice docid\ bryu8hm9xths2mzneikep voucher number enter (map) the voucher number whose details you want to search limit set the maximum number of vouchers make should return during one execution cycle list voucher retrieves a list of vouchers connection lexoffice docid\ bryu8hm9xths2mzneikep 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 make should return during one execution cycle create a voucher creates a new voucher connection lexoffice docid\ bryu8hm9xths2mzneikep 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 creates a new voucher connection lexoffice docid\ bryu8hm9xths2mzneikep 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 invoice connection lexoffice docid\ bryu8hm9xths2mzneikep 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 lexoffice docid\ bryu8hm9xths2mzneikep 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 lexoffice docid\ bryu8hm9xths2mzneikep 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