lexoffice

opencollection: 1.0.0
info:
  name: lexoffice (lexware Office) Public API
  version: '1.0'
request:
  auth:
    type: bearer
    token: '{{apiKey}}'
items:
- info:
    name: Contacts
    type: folder
  items:
  - info:
      name: Filter contacts.
      type: http
    http:
      method: GET
      url: https://api.lexware.io/v1/contacts?page=0&size=25
      params:
      - name: email
        value: ''
        type: query
        description: Filter by email address.
      - name: page
        value: '0'
        type: query
        description: Zero-based page index.
      - name: size
        value: '25'
        type: query
        description: Page size.
    docs: Returns a paged, filterable list of contacts.
  - info:
      name: Create a contact.
      type: http
    http:
      method: POST
      url: https://api.lexware.io/v1/contacts
      body:
        type: json
        data: "{\n  \"version\": 0,\n  \"roles\": { \"customer\": {} },\n  \"company\": { \"name\": \"Musterfirma GmbH\" }\n\
          }"
    docs: Creates a new contact (customer and/or vendor).
  - info:
      name: Retrieve a contact.
      type: http
    http:
      method: GET
      url: https://api.lexware.io/v1/contacts/:id
      params:
      - name: id
        value: ''
        type: path
        description: The UUID of the contact.
    docs: Retrieves a single contact by its UUID.
  - info:
      name: Update a contact.
      type: http
    http:
      method: PUT
      url: https://api.lexware.io/v1/contacts/:id
      params:
      - name: id
        value: ''
        type: path
        description: The UUID of the contact.
      body:
        type: json
        data: "{\n  \"version\": 1,\n  \"roles\": { \"customer\": {} },\n  \"company\": { \"name\": \"Musterfirma GmbH\" }\n\
          }"
    docs: Updates an existing contact (version required for optimistic locking).
- info:
    name: Invoices
    type: folder
  items:
  - info:
      name: Create an invoice.
      type: http
    http:
      method: POST
      url: https://api.lexware.io/v1/invoices?finalize=false
      params:
      - name: finalize
        value: 'false'
        type: query
        description: Create in open status instead of draft.
      body:
        type: json
        data: "{\n  \"voucherDate\": \"2026-07-12T00:00:00.000+02:00\",\n  \"address\": { \"name\": \"Musterfirma GmbH\",\
          \ \"countryCode\": \"DE\" },\n  \"lineItems\": [ { \"type\": \"custom\", \"name\": \"Beratung\", \"quantity\": 1,\
          \ \"unitName\": \"Stunde\", \"unitPrice\": { \"currency\": \"EUR\", \"netAmount\": 100.0, \"taxRatePercentage\"\
          : 19 } } ],\n  \"taxConditions\": { \"taxType\": \"net\" },\n  \"totalPrice\": { \"currency\": \"EUR\" }\n}"
    docs: Creates an invoice. Pass finalize=true to create it in the open status.
  - info:
      name: Retrieve an invoice.
      type: http
    http:
      method: GET
      url: https://api.lexware.io/v1/invoices/:id
      params:
      - name: id
        value: ''
        type: path
        description: The UUID of the invoice.
    docs: Retrieves a single invoice by its UUID.
  - info:
      name: Request the invoice PDF.
      type: http
    http:
      method: GET
      url: https://api.lexware.io/v1/invoices/:id/document
      params:
      - name: id
        value: ''
        type: path
        description: The UUID of the invoice.
    docs: Returns a documentFileId used to download the rendered PDF via the Files endpoint.
- info:
    name: Vouchers
    type: folder
  items:
  - info:
      name: Create a voucher.
      type: http
    http:
      method: POST
      url: https://api.lexware.io/v1/vouchers
      body:
        type: json
        data: "{\n  \"type\": \"salesinvoice\",\n  \"voucherNumber\": \"RE-2026-001\",\n  \"voucherDate\": \"2026-07-12\"\
          ,\n  \"totalGrossAmount\": 119.0,\n  \"totalTaxAmount\": 19.0,\n  \"taxType\": \"gross\",\n  \"useCollectiveContact\"\
          : true,\n  \"voucherItems\": [ { \"amount\": 119.0, \"taxAmount\": 19.0, \"taxRatePercent\": 19.0, \"categoryId\"\
          : \"8f8464a8-5023-41f8-a481-e8e8f38a10c8\" } ]\n}"
    docs: Creates a bookkeeping voucher for preliminary accounting.
  - info:
      name: Retrieve a voucher.
      type: http
    http:
      method: GET
      url: https://api.lexware.io/v1/vouchers/:id
      params:
      - name: id
        value: ''
        type: path
        description: The UUID of the voucher.
    docs: Retrieves a voucher by its UUID.
  - info:
      name: Update a voucher.
      type: http
    http:
      method: PUT
      url: https://api.lexware.io/v1/vouchers/:id
      params:
      - name: id
        value: ''
        type: path
        description: The UUID of the voucher.
      body:
        type: json
        data: '{}'
    docs: Updates an existing voucher.
  - info:
      name: Delete a voucher.
      type: http
    http:
      method: DELETE
      url: https://api.lexware.io/v1/vouchers/:id
      params:
      - name: id
        value: ''
        type: path
        description: The UUID of the voucher.
    docs: Deletes a voucher.
  - info:
      name: Search the voucher list.
      type: http
    http:
      method: GET
      url: https://api.lexware.io/v1/voucherlist?voucherType=invoice&voucherStatus=open&page=0&size=25
      params:
      - name: voucherType
        value: invoice
        type: query
        description: Required. Comma-separated voucher types.
      - name: voucherStatus
        value: open
        type: query
        description: Required. Comma-separated statuses.
      - name: page
        value: '0'
        type: query
        description: Zero-based page index.
      - name: size
        value: '25'
        type: query
        description: Page size.
    docs: Filterable list of voucher-type documents. voucherType and voucherStatus are required.
  - info:
      name: Upload a file.
      type: http
    http:
      method: POST
      url: https://api.lexware.io/v1/files
      body:
        type: text
        data: 'multipart/form-data with parts: file (binary), type=voucher'
    docs: Uploads a receipt file (PDF/JPG/PNG) to attach to a voucher.
- info:
    name: Event Subscriptions
    type: folder
  items:
  - info:
      name: List event subscriptions.
      type: http
    http:
      method: GET
      url: https://api.lexware.io/v1/event-subscriptions
    docs: Lists all event subscriptions (webhooks).
  - info:
      name: Create an event subscription.
      type: http
    http:
      method: POST
      url: https://api.lexware.io/v1/event-subscriptions
      body:
        type: json
        data: "{\n  \"eventType\": \"invoice.created\",\n  \"callbackUrl\": \"https://example.com/webhooks/lexoffice\"\n}"
    docs: Registers an HTTPS callback URL for an event type.
  - info:
      name: Retrieve an event subscription.
      type: http
    http:
      method: GET
      url: https://api.lexware.io/v1/event-subscriptions/:id
      params:
      - name: id
        value: ''
        type: path
        description: The UUID of the subscription.
    docs: Retrieves an event subscription by its UUID.
  - info:
      name: Delete an event subscription.
      type: http
    http:
      method: DELETE
      url: https://api.lexware.io/v1/event-subscriptions/:id
      params:
      - name: id
        value: ''
        type: path
        description: The UUID of the subscription.
    docs: Deletes an event subscription.
- info:
    name: Payments
    type: folder
  items:
  - info:
      name: Retrieve payment status for a voucher.
      type: http
    http:
      method: GET
      url: https://api.lexware.io/v1/payments/:voucherId
      params:
      - name: voucherId
        value: ''
        type: path
        description: The UUID of the voucher.
    docs: Returns the open amount, payment status, and payment items for a voucher.
  - info:
      name: List payment conditions.
      type: http
    http:
      method: GET
      url: https://api.lexware.io/v1/payment-conditions
    docs: Returns the payment conditions configured in the account.
- info:
    name: Profile & Metadata
    type: folder
  items:
  - info:
      name: Retrieve the account profile.
      type: http
    http:
      method: GET
      url: https://api.lexware.io/v1/profile
    docs: Returns the connected organization's profile and connection metadata.
  - info:
      name: List countries.
      type: http
    http:
      method: GET
      url: https://api.lexware.io/v1/countries
    docs: Returns the list of supported countries with tax classification.
  - info:
      name: List posting categories.
      type: http
    http:
      method: GET
      url: https://api.lexware.io/v1/posting-categories
    docs: Returns the posting categories used to classify voucher items.
bundled: true