Actions29
- Article Actions
- Contact Actions
- Credit Note Actions
- File Actions
- Invoice Actions
- Payment Actions
- Profile Actions
- Quotation Actions
- Recurring Invoice Template Actions
- Voucher Actions
- Voucherlist Actions
Credit Note → Create Credit Note
AI-generatedOverview
This node operation creates a credit note in LexwareOffice. It is useful for businesses that need to issue credit notes to customers for returned goods, refunds, or adjustments to invoices. For example, a company can automate the creation of credit notes when processing returns or correcting billing errors.
Use Case Examples
- Creating a draft credit note for a returned product with detailed line items and recipient address.
- Finalizing a credit note immediately upon creation to send it to the customer with a specified due date and payment conditions.
Properties
| Name | Meaning |
|---|---|
| Organization ID | Unique ID of the organization the credit note belongs to, required to specify the organization context. |
| Voucher Status | Status of the credit note, either draft (editable) or open (finalized and sent). |
| Voucher Date | Date of the credit note; only the date part is used, time is ignored. |
| Due Date | Due date for payment of the credit note; only the date part is used, time is ignored. |
| Language | Language of the credit note, e.g., German or English. |
| Finalize | Boolean flag indicating whether to create the credit note in finalized state (open) or draft mode. |
| Address | Address details of the credit note recipient, including optional contact ID, name, street, city, zip, country code, and contact person. |
| XRechnung | Properties for XRechnung enabled credit notes, such as buyer reference (Leitweg-ID). |
| Line Items | Items included in the credit note, each with ID, type (service, material, custom, text), name, description, quantity, unit name, and unit price details (currency, net amount, gross amount, tax rate). |
| Total Price | Total price details of the credit note including currency, total net amount, total gross amount, and total tax amount. |
| Tax Conditions | Tax conditions for the credit note, specifying the type of tax calculation such as net, gross, VAT free, or special cases like construction service or intra-community supply. |
| Payment Conditions | Payment terms and discount conditions for the credit note, including payment term label, duration, and discount percentage and range. |
| Shipping Conditions | Shipping details including type (delivery, service, none, etc.), shipping date, and shipping end date for periods. |
| Related Vouchers | Related vouchers such as invoice ID linked to the credit note. |
| Print Layout ID | ID of the print layout to be used for the credit note. |
| Title | Title of the credit note; defaults to organization's default if not provided. |
| Introduction | Introductory text or header for the credit note; defaults to organization's default if not provided. |
| Remark | Closing text note for the credit note; defaults to organization's default if not provided. |
Output
JSON
id- Unique identifier of the created credit noteorganizationId- ID of the organization the credit note belongs tovoucherStatus- Status of the credit note (draft or open)voucherDate- Date of the credit notedueDate- Due date for paymentlanguage- Language of the credit notefinalize- Indicates if the credit note was created finalized or as draftaddress- Address details of the credit note recipientxRechnung- XRechnung properties if applicablelineItems- List of line items included in the credit notetotalPrice- Total price details of the credit notetaxConditions- Tax conditions applied to the credit notepaymentConditions- Payment terms and discount conditionsshippingConditions- Shipping details related to the credit noterelatedVouchers- Related vouchers such as linked invoice IDsprintLayoutId- Print layout ID used for the credit notetitle- Title of the credit noteintroduction- Introductory text or headerremark- Closing text note
Dependencies
- An API key credential for LexwareOffice to authenticate requests
Troubleshooting
- Ensure all required fields like Organization ID and Voucher Date are provided to avoid validation errors.
- If the credit note fails to create, check the API credentials and network connectivity.
- Invalid date formats or missing required address fields may cause errors; ensure dates are in correct format and address includes required country code if no contact ID is provided.
Links
- LexwareOffice Credit Notes API Documentation - Official API documentation for managing credit notes in LexwareOffice