Module lexoffice::model[][src]

This model was semi-automaticly generated from The official lexoffice documentation

See https://developers.lexoffice.io/docs/ for more information

Re-exports

pub use contacts::Contact;
pub use countries::Country;
pub use credit_notes::CreditNote;
pub use down_payment_invoices::DownPaymentInvoice;
pub use event_subscriptions::EventSubscription;
pub use files::File;
pub use invoices::Invoice;
pub use order_confirmations::OrderConfirmation;
pub use pages::Page;
pub use payment_conditions::PaymentCondition;
pub use payments::Payment;
pub use posting_categories::PostingCategory;
pub use profile::Profile;
pub use quotations::Quotation;
pub use recurring_templates::RecurringTemplate;
pub use voucherlist::Voucherlist;
pub use vouchers::Voucher;

Modules

contacts

This endpoint provides read access to contacts (e.g. customers, vendors). A contact can hold addresses, contact information (e.g. phone numbers, email addresses) and contact persons for company related contacts. It is also possible to use filters on the contacts collection.

countries

The countries endpoint provides read access to the list of countries known to lexoffice.

credit_notes

This endpoint provides read and write access to credit notes and also the possibility to render the document as a PDF in order to download it. Credit notes can be created as a draft or finalized in open mode.

down_payment_invoices

This endpoint provides read-only access to down payment invoices.

event_subscriptions

Using event subscriptions you will be notified about certain events on resources - e.g. you receive a notification every time a contact changes in lexoffice. This will make pull requests superfluous to keep your data synced between lexoffice and your application. The notifications are implemented as webhooks. Subscribing to an event simply requires the event type and your callback url. With the event-subscriptions endpoint you can manage your subscriptions within lexoffice.

files

Use this endpoint to upload and/or download files, e.g. vouchers or invoices.

invoices

This endpoint provides read and write access to invoices. The created document(s) can be rendered as PDF files, and, depending on the input data, in the German XRechung data format. PDF files can be downloaded. Invoices can be created in draft or open (finalized) states.

order_confirmations

This endpoint provides read and write access to order confirmations and also the possibility to render the document as a PDF in order to download it. Order confirmations are always created in draft mode and do not need to be finalized.

pages
payment_conditions

The payment conditions endpoint provides read access to the list of payment conditions configured in lexoffice.

payments

The payments endpoint provides read access to the payment status of (bookkeeping or sales) vouchers, including invoices and credit notes.

posting_categories

This endpoint provides read access to the list of posting categories for the (bookkeeping) vouchers revenue or expense which are supported in lexoffice.

profile

The profile endpoint provides read access to basic profile information such as company name, user id, name and email of the connected lexoffice account.

quotations

This endpoint provides read and write access to quotations and also the possibility to render the document as a PDF in order to download it. Quotations can be created as a draft or finalized in open mode.

recurring_templates

This endpoint provides read-only access to the templates of recurring invoices, either individually or all as collection. Based on recurring invoice templates, lexoffice will create regular invoices in configured intervals. This operation is executed at night around 2am CET/CEST.

voucherlist

The voucherlist endpoint provides read access to meta data of (bookkeeping) vouchers (e.g. salesinvoices, salescreditnotes), invoices (including down payment invoices), credit notes, order confirmations, and quotations. For filters that can be applied to the list see below. Details concerning items from the list are accessible by id using the respective endpoint. For more information on the different voucher types refer to the documentation on the respective endpoints.

vouchers

The voucher endpoint provides read/write access to (bookkeeping) sales vouchers (e.g. invoices, creditnotes). For the lexoffice API, write access is currently restricted to sales vouchers, while purchase vouchers can be read.