LexwareOffice icon

LexwareOffice

Node to interact with LexwareOffice

Actions29

Contact → Create

AI-generated

Overview

This node operation creates a new contact in LexwareOffice. It is useful for adding customer or vendor contact information into the system, including details such as organization ID, roles, company or person information, addresses, email addresses, phone numbers, notes, and XRechnung properties. Practical examples include adding a new customer with billing and shipping addresses, or registering a vendor with specific contact roles and communication details.

Use Case Examples

  1. Creating a new customer contact with company details and multiple billing addresses.
  2. Adding a vendor contact with personal details and business phone numbers.

Properties

Name Meaning
Organization ID Unique ID of the organization the contact belongs to.
Version Version (revision) number which must be 0 for creation.
Roles Defines contact roles such as customer or vendor, each with a contact number. At least one role is required.
Company Company details required if the contact is a company. Person details must be absent if company details are provided.
Person Person details required if the contact is a person. Company details must be absent if person details are provided.
Addresses Defines billing and shipping addresses for the contact, each with supplement, street, ZIP code, city, and country code.
XRechnung XRechnung related properties including buyer reference and vendor number at customer.
Email Addresses Email addresses categorized by type: business, office, private, and other.
Phone Numbers Phone numbers categorized by type: business, office, mobile, private, fax, and other. Maximum one entry per type when creating or updating contacts.
Note Additional note to the contact with a maximum length of 1000 characters.
Archived Whether the contact is archived. This is a read-only property.
Request Options Node settings for request options including batching, SSL certificate validation, proxy, and timeout settings.

Output

JSON

  • id - Unique identifier of the created contact.
  • organizationId - ID of the organization the contact belongs to.
  • version - Version number of the contact record.
  • roles - Roles assigned to the contact, such as customer or vendor with their numbers.
  • company - Company details if the contact is a company.
  • person - Person details if the contact is a person.
  • addresses
    • billing - List of billing addresses associated with the contact.
    • shipping - List of shipping addresses associated with the contact.
  • xRechnung
    • buyerReference - Customer's Leitweg-ID for XRechnung.
    • vendorNumberAtCustomer - Vendor number as used by the customer for XRechnung.
  • emailAddresses
    • business - List of business email addresses.
    • office - List of office email addresses.
    • private - List of private email addresses.
    • other - List of other email addresses.
  • phoneNumbers
    • business - Business phone numbers.
    • office - Office phone numbers.
    • mobile - Mobile phone numbers.
    • private - Private phone numbers.
    • fax - Fax numbers.
    • other - Other phone numbers.
  • note - Additional note information about the contact.
  • archived - Indicates if the contact is archived.

Dependencies

  • An API key credential for LexwareOffice API authentication

Troubleshooting

  • Ensure the version number is set to 0 when creating a new contact, as non-zero values may cause errors.
  • At least one role must be defined for the contact; missing roles will result in validation errors.
  • If providing company details, person details must be absent and vice versa to avoid conflicts.
  • Maximum one phone number entry per type is allowed when creating or updating contacts; multiple entries may cause errors.
  • Check that email addresses and phone numbers are correctly formatted to prevent request failures.
  • If SSL certificate validation fails, enable the 'Ignore SSL Issues' option or configure a valid certificate.
  • Proxy settings must be correctly formatted if used, including authentication if required.
  • Timeout settings should be adjusted based on network conditions to avoid premature request aborts.

Discussion