LexwareOffice icon

LexwareOffice

Node to interact with LexwareOffice

Actions29

Voucher → Update

AI-generated

Overview

This node operation updates an existing voucher in LexwareOffice. It allows users to modify voucher details such as voucher ID, organization ID, voucher number, type, status, dates, amounts, tax type, contact information, remarks, voucher items, attached files, and version for optimistic locking. This operation is useful for maintaining accurate and up-to-date financial records, correcting errors, or adding additional information to vouchers after their initial creation.

Use Case Examples

  1. Updating a sales invoice voucher to correct the voucher number and add additional remarks.
  2. Changing the status of a purchase invoice voucher from 'open' to 'unchecked' after review.
  3. Modifying voucher items to adjust amounts and tax rates for a sales credit note.

Properties

Name Meaning
Voucher ID Unique ID of the voucher generated on creation by Lexoffice, used to identify which voucher to update.
Organization ID Unique ID of the organization generated on creation by Lexoffice, used to specify the organization the voucher belongs to.
Voucher Number Number of the voucher, typically the order's identification reference number.
Voucher Type Type of the voucher, such as sales invoice, sales credit note, purchase invoice, or purchase credit note.
Voucher Status Status of the voucher, writable values are 'open' and 'unchecked'.
Voucher Date Date when the voucher was issued (date only, time ignored).
Shipping Date Date when the purchased item/service is to be shipped or supplied (only for salesinvoice and salescreditnote).
Due Date Date when the voucher's payment must be settled (date only, time ignored).
Total Gross Amount Total gross amount of the voucher, must match sum of all positions including tax.
Total Tax Amount Total tax amount of the voucher, must match sum of all positions' tax amounts.
Tax Type Tax type of the order, either net (taxes added) or gross (tax included).
Use Collective Contact Whether to use the collective contact within Lexoffice, ignoring contactId if true.
Contact Name Name of the recipient or invoicing party if collective contact is used.
Contact ID ID of an existing contact if not using collective contact, must exist in Lexoffice.
Remark Comments or remarks for the voucher, searchable in Lexoffice.
Voucher Items Positions of the voucher grouped by tax rate, including amount, tax amount, tax rate percent, and category ID.
Files List of voucher image file IDs assigned to the voucher; omitting existing file IDs during update deletes them permanently.
Version Version number for optimistic locking, must match latest version from Lexoffice to avoid losing changes.

Output

JSON

  • id - Unique identifier of the updated voucher.
  • organizationId - Identifier of the organization the voucher belongs to.
  • voucherNumber - Number assigned to the voucher.
  • type - Type of the voucher (e.g., salesinvoice, salescreditnote).
  • voucherStatus - Current status of the voucher.
  • voucherDate - Date when the voucher was issued.
  • shippingDate - Date when the item/service is to be shipped or supplied.
  • dueDate - Date when payment is due.
  • totalGrossAmount - Total gross amount of the voucher.
  • totalTaxAmount - Total tax amount of the voucher.
  • taxType - Tax type used in the voucher (net or gross).
  • useCollectiveContact - Indicates if collective contact is used.
  • contactName - Name of the contact if collective contact is used.
  • contactId - ID of the contact if collective contact is not used.
  • remark - Remarks or comments on the voucher.
  • voucherItems - Array of voucher items with details like amount, tax amount, tax rate, and category.
  • files - Array of file IDs assigned to the voucher.
  • version - Current version number of the voucher for optimistic locking.

Dependencies

  • Requires an API key credential for LexwareOffice to authenticate requests.

Troubleshooting

  • Ensure the voucher ID provided exists in LexwareOffice; otherwise, the update will fail.
  • Version mismatch errors can occur if the version number does not match the latest version in LexwareOffice; fetch the latest version before updating.
  • Only 'open' and 'unchecked' voucher statuses are writable; attempting to set other statuses may cause errors.
  • Omitting existing file IDs during update will permanently delete those files; ensure to include all files you want to keep.

Links

Discussion