Skip to content
Developer

CRMTicket

Tickets and projects14 EndpointsCRM / CRMTicket

This method will get all CustomerTicket Objects

GET/api/crm/tickets

Query parameters

idstring, LOGGED_IN
inportalboolean
deletedstring, LOGGED_IN
crmProjectstring, LOGGED_IN
crmProjectItemstring, LOGGED_IN
createdByUserstring, LOGGED_IN
assignedUserstring, LOGGED_IN
companystring, LOGGED_IN
statusstring, LOGGED_IN
archivedboolean, LOGGED_IN
crmProjectCategoryAreastring, LOGGED_IN
unifiedCategorystring, LOGGED_IN
calculatedScoreDueDatestring, LOGGED_IN
calculatedScoreBusinessValuestring, LOGGED_IN
calculatedScorestring, LOGGED_IN
businessValuestring, LOGGED_IN
issuecategorystringA category like website, hosting, marketing | , LOGGED_IN
statusidstring, LOGGED_IN
createdstring, LOGGED_IN
headlinestring, LOGGED_IN
duedatestring, LOGGED_IN
ticketTypestring, LOGGED_IN
reopenDatestring, LOGGED_IN
sprintstringThe sprint this ticket is planned for. Tickets without a sprint are the backlog. | , LOGGED_IN
storyPointsstringRelative planning estimate used during sprint planning | , LOGGED_IN
boardOrderstringManual position of the ticket inside its kanban column / sprint backlog | , LOGGED_IN
aiUrgencyScorestringInterner Dringlichkeits-Score 0-100 aus der KI-Triage (TicketAiTriageHelper), null = nicht bewertet. Nur fuer das Team sichtbar.
aiEmergencystringDie KI-Triage hat das Ticket als absoluten Notfall erkannt (das Team wurde zusaetzlich benachrichtigt). null = nicht geprueft.
searchStringstringtext to search for in the list
orderFieldNamestringname of the order field
orderFieldSortstringsorting modeAllowed: DESCASC
pageintegerpage of the list
pageSizeintegernumber of entries for each page
withMaxPageNumberstringreturns the number of pages available as a header if this is set

Responses

200Returns a list of CustomerTicket objectsarray<CustomerTicket>

Show fields (21)
  • satisfaction_requested_atstring

    When the customer / member was asked to rate the finished ticket; the apps offer the rating once this is set.

  • idinteger

    Primary key of the ticket. Internal ID.

  • ticket_typestring

    Type of the ticket.

  • numberinteger

    Running ticket number.

  • number_stringstring

    Ticket number as displayed to users.

  • companyCRMCompany

    Company the ticket belongs to.

    Show fields (55)
    • idinteger

      Primary key of the company. Internal ID.

    • short_namestring

      Short name of the company.

    • company_namestring

      Legal name of the company.

    • secondary_namestring

      Second name line of the company.

    • direct_dialstring

      Direct dial number of the company.

    • invoice_emailstring

      E-mail address for invoices.

    • send_invoice_emailboolean

      Send invoices by e-mail.

    • send_invoice_letterboolean

      Send invoices by letter.

    • time_report_emailstring

      E-mail address for time reports.

    • payment_goalPaymentGoal

      Payment term of the company.

    • payment_intervalstring

      Interval of the payments.

    • vatidstring

      VAT identification number.

    • taxnumberstring

      Tax number of the company.

    • buyer_reference_idstring

      Leitweg-ID or custom reference ID defined by the customer

    • taxTax

      Tax rate used for the company.

    • infostring

      Information about the company.

    • numberstring

      Customer or supplier number of the company.

    • manual_numberinteger

      Number set manually instead of the automatic number.

    • number_stringstring

      Company number as text, including prefix.

    • is_customerboolean

      The company is a customer.

    • is_supplierboolean

      The company is a supplier.

    • is_otherboolean

      The company is neither customer nor supplier.

    • is_memberboolean

      The company is a member.

    • archivedboolean

      The company is archived.

    • categoryCRMCompanyCategory

      Category of the company.

    • visible_for_customerboolean

      Whether the company is visible to the customer.

    • founding_datestring (date-time)

      Founding date of the company.

    • nace_sectionstring

      NACE section code (letter A-U)

    • nace_codestring

      NACE code (numeric like 01.11, 62.01)

    • search_stringstring

      Text that the entity can be searched by.

    • addressstring

      Address as text.

    • address_streetstring

      Street of the address.

    • address_house_numberstring

      House number of the address.

    • address_street_levelstring

      Street and house number of the address.

    • address_costring

      Care-of line of the address.

    • address_citystring

      City of the address.

    • address_zipstring

      Postal code of the address.

    • address_admin_level1string

      First administrative level of the address, e.g. the federal state.

    • address_countrystring

      Country code of the address.

    • address_full_countrystring

      Full name of the country of the address.

    • address_geo_latstring

      Latitude of the address.

    • address_geo_lngstring

      Longitude of the address.

    • address_external_provider_idstring

      field to store the external provider id of the address. e.g. Google Maps PlaceID like google:ChIJVcKw5r90sEcRhdjNq6NItqE

    • main_phonestring

      Main phone number.

    • main_faxstring

      Main fax number.

    • main_emailstring

      Main e-mail address.

    • websitestring

      Website address.

    • createdstring (date-time)

      Point in time the entity was created.

    • updatedstring (date-time)

      Point in time the entity was last updated.

    • payment_typePaymentType
    • company_employee_countinteger

      Number of employees of the company.

    • company_founding_yearinteger

      Founding year of the company.

    • company_family_ownedboolean

      Whether the company is family-owned.

    • company_sales_volumestring

      Sales volume of the company.

    • company_segmentstring

      Market segment of the company.

  • personCRMPerson10

    Person the ticket belongs to.

    Show fields (81)
    • idinteger

      Primary key of the person. Internal ID.

    • first_namestring

      First name of the person.

    • last_namestring

      Last name of the person.

    • numberinteger

      Member or customer number of the person.

    • manual_numberinteger

      Number set manually instead of the automatic number.

    • number_stringstring

      Member or customer number as text, including prefix.

    • genderstring

      Gender of the person.

    • titlestring

      Academic or other title of the person.

    • positionstring

      Position or role of the person.

    • languagestring

      Preferred language of the person.

    • special_salutationstring

      Special salutation text for letters.

    • form_of_salutationstring

      Form of salutation, for example formal or informal.

    • birthdaystring (date-time)

      Birthday of the person.

    • known_allergiesstring

      Known allergies of the person.

    • confirmed_no_allergiesboolean

      Guardian confirmed that there are no known allergies.

    • allow_photosboolean

      Photos of the person may be taken and published.

    • allow_leaving_aloneboolean

      The person may leave the event alone.

    • authorized_pickupstring

      Persons who are allowed to pick up the person.

    • needs_supportboolean

      The person needs support, for example for inclusion.

    • support_descriptionstring

      Description of the support the person needs.

    • financial_supportboolean

      The person receives financial support.

    • financial_support_numberstring

      Number of the financial support.

    • municipal_supportboolean

      The person receives municipal support.

    • municipal_support_numberstring

      Number of the municipal support.

    • grade_levelinteger

      School grade level of the person.

    • school_classstring

      School class of the person.

    • start_timestring (date-time)

      Start of the membership or activity.

    • start_time_reasonstring

      Reason for the start.

    • end_timestring (date-time)

      End of the membership or activity.

    • end_time_reasonstring

      Reason for the end.

    • confirmed_gtc_timestring (date-time)

      Time the general terms and conditions were confirmed.

    • chatbot_opt_inboolean

      Einwilligung in die Nutzung des KI-Assistenten. Denormalisierter aktueller Stand - das pruefbare Protokoll steht in ChatbotConsent.

    • chatbot_opt_in_atstring (date-time)

      Time the person opted in to the chatbot.

    • chatbot_opt_in_text_versionstring

      Version des Einwilligungstextes, dem zugestimmt wurde. Weicht sie von der aktuellen Version ab, ist das Opt-in abgelaufen.

    • app_usage_statistics_opt_outboolean

      Widerspruch gegen die anonyme Nutzungsstatistik der Mitglieder-App. Die App liest ihn aus den StaticData und schickt dann nichts mehr; die gezaehlten Aufrufe selbst haben keinen Bezug zur Person.

    • crm_person_contact_dataarray<CRMPersonContactData>

      Contact data of the person, for example phone and e-mail.

    • archivedboolean

      Whether the person is archived.

    • subscribed_newsletterboolean

      Whether the person subscribed to the newsletter.

    • subscribed_magazineboolean

      Whether the person subscribed to the magazine.

    • printed_member_cardboolean

      Whether a member card has been printed for the person.

    • has_login_userboolean

      Whether the person has a login user.

    • profile_picture_urlstring

      URL of the profile picture of the person.

    • log_book_staffboolean

      Log book flag: staff.

    • log_book_staff1boolean

      Log book flag: staff, level 1.

    • log_book_staff2boolean

      Log book flag: staff, level 2.

    • log_book_memberboolean

      Log book flag: member.

    • log_book_trainerboolean

      Log book flag: trainer.

    • log_book_trainer1boolean

      Log book flag: trainer, level 1.

    • log_book_trainer2boolean

      Log book flag: trainer, level 2.

    • log_book_head_of_departmentboolean

      Log book flag: head of department.

    • log_book_supervisory_boardboolean

      Log book flag: supervisory board.

    • log_book_board_of_directorsboolean

      Log book flag: board of directors.

    • log_book_honorary_memberboolean

      Log book flag: honorary member.

    • log_book_club_card_oneboolean

      Log book flag: club card.

    • log_book_health_recoveredboolean

      Log book flag: recovered from illness.

    • log_book_health_vaccinatedboolean

      Log book flag: vaccinated.

    • log_book_health_vaccinated_additionstring

      Details of the vaccination.

    • log_book_good_conductboolean

      Log book flag: certificate of good conduct.

    • log_book_first_aidboolean

      Log book flag: first aid training.

    • log_book_measles_vaccinationboolean

      Log book flag: measles vaccination.

    • sync_lanistaboolean

      Whether the person is synchronized with Lanista.

    • categoryCRMPersonCategory

      Person category.

    • nicknamestring

      Nickname of the person.

    • preferred_color_hexstring

      Preferred color of the person as hex value.

    • avatar_tokenstring

      Token of the avatar image.

    • search_stringstring

      Text that the entity can be searched by.

    • addressstring

      Address as text.

    • address_streetstring

      Street of the address.

    • address_house_numberstring

      House number of the address.

    • address_street_levelstring

      Street and house number of the address.

    • address_costring

      Care-of line of the address.

    • address_citystring

      City of the address.

    • address_zipstring

      Postal code of the address.

    • address_admin_level1string

      First administrative level of the address, e.g. the federal state.

    • address_countrystring

      Country code of the address.

    • address_full_countrystring

      Full name of the country of the address.

    • address_geo_latstring

      Latitude of the address.

    • address_geo_lngstring

      Longitude of the address.

    • address_external_provider_idstring

      field to store the external provider id of the address. e.g. Google Maps PlaceID like google:ChIJVcKw5r90sEcRhdjNq6NItqE

    • createdstring (date-time)

      Point in time the entity was created.

    • … 2 more fields
  • jirakeystring

    Key of the linked Jira issue.

  • jiraidstring

    ID of the linked Jira issue.

  • assignedusernamestring

    Name of the assigned user, as text.

  • assigned_userUser

    User the ticket is assigned to.

    Show fields (11)
    • idinteger

      Primary key of the user. Internal ID of the login user.

    • namestring

      Display name of the user. Shown in the UI and in audit entries.

    • usernamestring

      Login name of the user. Must be unique across all users.

    • emailstring

      E-mail address of the user. Used for login notifications, password resets and as a login alias.

    • user_access_groupUserAccessGroup3

      User access group of the user. Defines the rights of the user for all scopes.

    • positioningeneralstring

      Free text describing the position or role of the user.

    • crm_personCRMPerson10

      CRM person linked to this login user. Connects the login account with the person record.

    • profile_picture_urlstring

      URL of the profile picture of the user.

    • archivedboolean

      Marks the user as archived. Archived users are kept for history and are not active.

    • require2faboolean

      Two-factor authentication is required for this user.

    • search_stringstring

      Text that the entity can be searched by.

  • createdbyusernamestring

    Name of the user who created the ticket, as text.

  • created_by_userUser

    User who created the ticket.

    Show fields (11)
    • idinteger

      Primary key of the user. Internal ID of the login user.

    • namestring

      Display name of the user. Shown in the UI and in audit entries.

    • usernamestring

      Login name of the user. Must be unique across all users.

    • emailstring

      E-mail address of the user. Used for login notifications, password resets and as a login alias.

    • user_access_groupUserAccessGroup3

      User access group of the user. Defines the rights of the user for all scopes.

    • positioningeneralstring

      Free text describing the position or role of the user.

    • crm_personCRMPerson10

      CRM person linked to this login user. Connects the login account with the person record.

    • profile_picture_urlstring

      URL of the profile picture of the user.

    • archivedboolean

      Marks the user as archived. Archived users are kept for history and are not active.

    • require2faboolean

      Two-factor authentication is required for this user.

    • search_stringstring

      Text that the entity can be searched by.

  • statusstring

    Status of the ticket as text.

  • statusidstring

    ID of the status of the ticket.

  • issuetypestring

    A type like bug, task, story

  • issuecategorystring

    A category like website, hosting, marketing

  • crm_project_category_areaCRMProjectCategoryArea

    Project category area the ticket belongs to.

    Show fields (4)
    • idinteger

      Primary key of the category area. Internal ID.

    • namestring

      Name of the area.

    • descriptionstring

      Description of the area.

    • deletedboolean

      This property is used to mark an entity as deleted / archived

  • issueprojectstring

    A project like a domain (inwendo.de) or a certain mail campaign

  • crm_projectCRMProject8

    CRM project the ticket belongs to.

    Show fields (19)
    • idinteger

      Primary key of the project. Internal ID.

    • namestring

      Name of the project.

    • closedstring (date-time)

      Time the project was closed.

    • billedstring (date-time)

      Time the project was billed.

    • numberstring

      Number of the project.

    • startstring (date-time)

      Start of the project.

    • endstring (date-time)

      End of the project.

    • descriptionstring

      Description of the project.

    • companyCRMCompany

      Company the project belongs to.

    • internal_main_contactUser

      Internal login user who is the main contact.

    • categoryCRMProjectCategory

      Category of the project.

    • archivedboolean

      The project is archived.

    • visible_for_customerboolean

      The project is visible in the customer app.

    • name_for_customerstring

      Name of the project shown to customers.

    • invoice_emailstring

      E-mail address for invoices of the project.

    • time_report_emailstring

      E-mail address for time reports of the project.

    • search_stringstring

      Text that the entity can be searched by.

    • createdstring (date-time)

      Point in time the entity was created.

    • updatedstring (date-time)

      Point in time the entity was last updated.

  • … 50 more fields
Request
curl --request GET \
  --url https://your-instance.iw-erp.de/api/crm/tickets \
  --header 'x-iw-jwt-token: <TOKEN>'
Response 200 application/json
[
  {
    "id": 42,
    "external_person_first_name": "Beispiel",
    "external_person_last_name": "Beispiel",
    "external_person_email": "lena.hartmann@example.org",
    "external_person_phone": "+49 511 123456",
    "external_person_address_city": "Hannover",
    "external_person_address_zip": "30163",
    "external_person_address_country": "DE",
    "external_company_name": "Beispiel",
    "external_company_email": "lena.hartmann@example.org"
  }
]

Add a new Ticket

POST/api/crm/tickets

Request body application/json

  • dataCustomerTicket2
    Show fields (1)
    • unified_categoryUnifiedCategory11

Responses

200Add a new TicketCustomerTicket3

Show fields (21)
  • satisfaction_requested_atstring

    When the customer / member was asked to rate the finished ticket; the apps offer the rating once this is set.

  • idinteger

    Primary key of the ticket. Internal ID.

  • ticket_typestring

    Type of the ticket.

  • numberinteger

    Running ticket number.

  • number_stringstring

    Ticket number as displayed to users.

  • companyCRMCompany19

    Company the ticket belongs to.

    Show fields (56)
    • idinteger

      Primary key of the company. Internal ID.

    • short_namestring

      Short name of the company.

    • company_namestring

      Legal name of the company.

    • secondary_namestring

      Second name line of the company.

    • direct_dialstring

      Direct dial number of the company.

    • invoice_emailstring

      E-mail address for invoices.

    • send_invoice_emailboolean

      Send invoices by e-mail.

    • send_invoice_letterboolean

      Send invoices by letter.

    • time_report_emailstring

      E-mail address for time reports.

    • payment_goalPaymentGoal

      Payment term of the company.

    • payment_intervalstring

      Interval of the payments.

    • vatidstring

      VAT identification number.

    • taxnumberstring

      Tax number of the company.

    • buyer_reference_idstring

      Leitweg-ID or custom reference ID defined by the customer

    • taxTax

      Tax rate used for the company.

    • infostring

      Information about the company.

    • numberstring

      Customer or supplier number of the company.

    • manual_numberinteger

      Number set manually instead of the automatic number.

    • number_stringstring

      Company number as text, including prefix.

    • is_customerboolean

      The company is a customer.

    • is_supplierboolean

      The company is a supplier.

    • is_otherboolean

      The company is neither customer nor supplier.

    • is_memberboolean

      The company is a member.

    • archivedboolean

      The company is archived.

    • categoryCRMCompanyCategory

      Category of the company.

    • visible_for_customerboolean

      Whether the company is visible to the customer.

    • founding_datestring (date-time)

      Founding date of the company.

    • nace_sectionstring

      NACE section code (letter A-U)

    • nace_codestring

      NACE code (numeric like 01.11, 62.01)

    • search_stringstring

      Text that the entity can be searched by.

    • addressstring

      Address as text.

    • address_streetstring

      Street of the address.

    • address_house_numberstring

      House number of the address.

    • address_street_levelstring

      Street and house number of the address.

    • address_costring

      Care-of line of the address.

    • address_citystring

      City of the address.

    • address_zipstring

      Postal code of the address.

    • address_admin_level1string

      First administrative level of the address, e.g. the federal state.

    • address_countrystring

      Country code of the address.

    • address_full_countrystring

      Full name of the country of the address.

    • address_geo_latstring

      Latitude of the address.

    • address_geo_lngstring

      Longitude of the address.

    • address_external_provider_idstring

      field to store the external provider id of the address. e.g. Google Maps PlaceID like google:ChIJVcKw5r90sEcRhdjNq6NItqE

    • main_phonestring

      Main phone number.

    • main_faxstring

      Main fax number.

    • main_emailstring

      Main e-mail address.

    • websitestring

      Website address.

    • createdstring (date-time)

      Point in time the entity was created.

    • updatedstring (date-time)

      Point in time the entity was last updated.

    • atagsarray<AccessTag>
    • payment_typePaymentType
    • company_employee_countinteger

      Number of employees of the company.

    • company_founding_yearinteger

      Founding year of the company.

    • company_family_ownedboolean

      Whether the company is family-owned.

    • company_sales_volumestring

      Sales volume of the company.

    • company_segmentstring

      Market segment of the company.

  • personCRMPerson10

    Person the ticket belongs to.

    Show fields (81)
    • idinteger

      Primary key of the person. Internal ID.

    • first_namestring

      First name of the person.

    • last_namestring

      Last name of the person.

    • numberinteger

      Member or customer number of the person.

    • manual_numberinteger

      Number set manually instead of the automatic number.

    • number_stringstring

      Member or customer number as text, including prefix.

    • genderstring

      Gender of the person.

    • titlestring

      Academic or other title of the person.

    • positionstring

      Position or role of the person.

    • languagestring

      Preferred language of the person.

    • special_salutationstring

      Special salutation text for letters.

    • form_of_salutationstring

      Form of salutation, for example formal or informal.

    • birthdaystring (date-time)

      Birthday of the person.

    • known_allergiesstring

      Known allergies of the person.

    • confirmed_no_allergiesboolean

      Guardian confirmed that there are no known allergies.

    • allow_photosboolean

      Photos of the person may be taken and published.

    • allow_leaving_aloneboolean

      The person may leave the event alone.

    • authorized_pickupstring

      Persons who are allowed to pick up the person.

    • needs_supportboolean

      The person needs support, for example for inclusion.

    • support_descriptionstring

      Description of the support the person needs.

    • financial_supportboolean

      The person receives financial support.

    • financial_support_numberstring

      Number of the financial support.

    • municipal_supportboolean

      The person receives municipal support.

    • municipal_support_numberstring

      Number of the municipal support.

    • grade_levelinteger

      School grade level of the person.

    • school_classstring

      School class of the person.

    • start_timestring (date-time)

      Start of the membership or activity.

    • start_time_reasonstring

      Reason for the start.

    • end_timestring (date-time)

      End of the membership or activity.

    • end_time_reasonstring

      Reason for the end.

    • confirmed_gtc_timestring (date-time)

      Time the general terms and conditions were confirmed.

    • chatbot_opt_inboolean

      Einwilligung in die Nutzung des KI-Assistenten. Denormalisierter aktueller Stand - das pruefbare Protokoll steht in ChatbotConsent.

    • chatbot_opt_in_atstring (date-time)

      Time the person opted in to the chatbot.

    • chatbot_opt_in_text_versionstring

      Version des Einwilligungstextes, dem zugestimmt wurde. Weicht sie von der aktuellen Version ab, ist das Opt-in abgelaufen.

    • app_usage_statistics_opt_outboolean

      Widerspruch gegen die anonyme Nutzungsstatistik der Mitglieder-App. Die App liest ihn aus den StaticData und schickt dann nichts mehr; die gezaehlten Aufrufe selbst haben keinen Bezug zur Person.

    • crm_person_contact_dataarray<CRMPersonContactData>

      Contact data of the person, for example phone and e-mail.

    • archivedboolean

      Whether the person is archived.

    • subscribed_newsletterboolean

      Whether the person subscribed to the newsletter.

    • subscribed_magazineboolean

      Whether the person subscribed to the magazine.

    • printed_member_cardboolean

      Whether a member card has been printed for the person.

    • has_login_userboolean

      Whether the person has a login user.

    • profile_picture_urlstring

      URL of the profile picture of the person.

    • log_book_staffboolean

      Log book flag: staff.

    • log_book_staff1boolean

      Log book flag: staff, level 1.

    • log_book_staff2boolean

      Log book flag: staff, level 2.

    • log_book_memberboolean

      Log book flag: member.

    • log_book_trainerboolean

      Log book flag: trainer.

    • log_book_trainer1boolean

      Log book flag: trainer, level 1.

    • log_book_trainer2boolean

      Log book flag: trainer, level 2.

    • log_book_head_of_departmentboolean

      Log book flag: head of department.

    • log_book_supervisory_boardboolean

      Log book flag: supervisory board.

    • log_book_board_of_directorsboolean

      Log book flag: board of directors.

    • log_book_honorary_memberboolean

      Log book flag: honorary member.

    • log_book_club_card_oneboolean

      Log book flag: club card.

    • log_book_health_recoveredboolean

      Log book flag: recovered from illness.

    • log_book_health_vaccinatedboolean

      Log book flag: vaccinated.

    • log_book_health_vaccinated_additionstring

      Details of the vaccination.

    • log_book_good_conductboolean

      Log book flag: certificate of good conduct.

    • log_book_first_aidboolean

      Log book flag: first aid training.

    • log_book_measles_vaccinationboolean

      Log book flag: measles vaccination.

    • sync_lanistaboolean

      Whether the person is synchronized with Lanista.

    • categoryCRMPersonCategory

      Person category.

    • nicknamestring

      Nickname of the person.

    • preferred_color_hexstring

      Preferred color of the person as hex value.

    • avatar_tokenstring

      Token of the avatar image.

    • search_stringstring

      Text that the entity can be searched by.

    • addressstring

      Address as text.

    • address_streetstring

      Street of the address.

    • address_house_numberstring

      House number of the address.

    • address_street_levelstring

      Street and house number of the address.

    • address_costring

      Care-of line of the address.

    • address_citystring

      City of the address.

    • address_zipstring

      Postal code of the address.

    • address_admin_level1string

      First administrative level of the address, e.g. the federal state.

    • address_countrystring

      Country code of the address.

    • address_full_countrystring

      Full name of the country of the address.

    • address_geo_latstring

      Latitude of the address.

    • address_geo_lngstring

      Longitude of the address.

    • address_external_provider_idstring

      field to store the external provider id of the address. e.g. Google Maps PlaceID like google:ChIJVcKw5r90sEcRhdjNq6NItqE

    • createdstring (date-time)

      Point in time the entity was created.

    • … 2 more fields
  • jirakeystring

    Key of the linked Jira issue.

  • jiraidstring

    ID of the linked Jira issue.

  • assignedusernamestring

    Name of the assigned user, as text.

  • assigned_userUser

    User the ticket is assigned to.

    Show fields (11)
    • idinteger

      Primary key of the user. Internal ID of the login user.

    • namestring

      Display name of the user. Shown in the UI and in audit entries.

    • usernamestring

      Login name of the user. Must be unique across all users.

    • emailstring

      E-mail address of the user. Used for login notifications, password resets and as a login alias.

    • user_access_groupUserAccessGroup3

      User access group of the user. Defines the rights of the user for all scopes.

    • positioningeneralstring

      Free text describing the position or role of the user.

    • crm_personCRMPerson10

      CRM person linked to this login user. Connects the login account with the person record.

    • profile_picture_urlstring

      URL of the profile picture of the user.

    • archivedboolean

      Marks the user as archived. Archived users are kept for history and are not active.

    • require2faboolean

      Two-factor authentication is required for this user.

    • search_stringstring

      Text that the entity can be searched by.

  • createdbyusernamestring

    Name of the user who created the ticket, as text.

  • created_by_userUser

    User who created the ticket.

    Show fields (11)
    • idinteger

      Primary key of the user. Internal ID of the login user.

    • namestring

      Display name of the user. Shown in the UI and in audit entries.

    • usernamestring

      Login name of the user. Must be unique across all users.

    • emailstring

      E-mail address of the user. Used for login notifications, password resets and as a login alias.

    • user_access_groupUserAccessGroup3

      User access group of the user. Defines the rights of the user for all scopes.

    • positioningeneralstring

      Free text describing the position or role of the user.

    • crm_personCRMPerson10

      CRM person linked to this login user. Connects the login account with the person record.

    • profile_picture_urlstring

      URL of the profile picture of the user.

    • archivedboolean

      Marks the user as archived. Archived users are kept for history and are not active.

    • require2faboolean

      Two-factor authentication is required for this user.

    • search_stringstring

      Text that the entity can be searched by.

  • statusstring

    Status of the ticket as text.

  • statusidstring

    ID of the status of the ticket.

  • issuetypestring

    A type like bug, task, story

  • issuecategorystring

    A category like website, hosting, marketing

  • crm_project_category_areaCRMProjectCategoryArea

    Project category area the ticket belongs to.

    Show fields (4)
    • idinteger

      Primary key of the category area. Internal ID.

    • namestring

      Name of the area.

    • descriptionstring

      Description of the area.

    • deletedboolean

      This property is used to mark an entity as deleted / archived

  • issueprojectstring

    A project like a domain (inwendo.de) or a certain mail campaign

  • crm_projectCRMProject9

    CRM project the ticket belongs to.

    Show fields (19)
    • idinteger

      Primary key of the project. Internal ID.

    • namestring

      Name of the project.

    • closedstring (date-time)

      Time the project was closed.

    • billedstring (date-time)

      Time the project was billed.

    • numberstring

      Number of the project.

    • startstring (date-time)

      Start of the project.

    • endstring (date-time)

      End of the project.

    • descriptionstring

      Description of the project.

    • companyCRMCompany19

      Company the project belongs to.

    • internal_main_contactUser

      Internal login user who is the main contact.

    • categoryCRMProjectCategory

      Category of the project.

    • archivedboolean

      The project is archived.

    • visible_for_customerboolean

      The project is visible in the customer app.

    • name_for_customerstring

      Name of the project shown to customers.

    • invoice_emailstring

      E-mail address for invoices of the project.

    • time_report_emailstring

      E-mail address for time reports of the project.

    • search_stringstring

      Text that the entity can be searched by.

    • createdstring (date-time)

      Point in time the entity was created.

    • … 1 more fields
  • … 51 more fields
Request
curl --request POST \
  --url https://your-instance.iw-erp.de/api/crm/tickets \
  --header 'content-type: application/json' \
  --header 'x-iw-jwt-token: <TOKEN>' \
  --data '
{
  "data": {
    "unified_category": {
      "address_street": "Jakobistr. 39",
      "address_city": "Hannover",
      "address_zip": "30163",
      "address_country": "DE",
      "address_full_country": "DE",
      "main_phone": "+49 511 123456"
    }
  }
}
'
Response 200 application/json
{
  "id": 42,
  "external_person_first_name": "Beispiel",
  "external_person_last_name": "Beispiel",
  "external_person_email": "lena.hartmann@example.org",
  "external_person_phone": "+49 511 123456",
  "external_person_address_city": "Hannover",
  "external_person_address_zip": "30163",
  "external_person_address_country": "DE",
  "external_company_name": "Beispiel",
  "external_company_email": "lena.hartmann@example.org"
}

Ratings of finished tickets in a period (customer_panel_ticket_satisfaction_enabled): count, average, distribution, per assignee and per area, and the comments.

GET/api/crm/tickets/satisfaction_report

Query parameters

fromstringStart date (Y-m-d), default 90 days ago
tostringEnd date (Y-m-d), default today

Responses

200The reportobject

Request
curl --request GET \
  --url https://your-instance.iw-erp.de/api/crm/tickets/satisfaction_report \
  --header 'x-iw-jwt-token: <TOKEN>'
Response 200 application/json
{}

This method will get a single Ticket with the given id

GET/api/crm/tickets/{id}

Path parameters

idrequiredstring

Responses

200Returns a single TicketCustomerTicket3

Show fields (21)
  • satisfaction_requested_atstring

    When the customer / member was asked to rate the finished ticket; the apps offer the rating once this is set.

  • idinteger

    Primary key of the ticket. Internal ID.

  • ticket_typestring

    Type of the ticket.

  • numberinteger

    Running ticket number.

  • number_stringstring

    Ticket number as displayed to users.

  • companyCRMCompany19

    Company the ticket belongs to.

    Show fields (56)
    • idinteger

      Primary key of the company. Internal ID.

    • short_namestring

      Short name of the company.

    • company_namestring

      Legal name of the company.

    • secondary_namestring

      Second name line of the company.

    • direct_dialstring

      Direct dial number of the company.

    • invoice_emailstring

      E-mail address for invoices.

    • send_invoice_emailboolean

      Send invoices by e-mail.

    • send_invoice_letterboolean

      Send invoices by letter.

    • time_report_emailstring

      E-mail address for time reports.

    • payment_goalPaymentGoal

      Payment term of the company.

    • payment_intervalstring

      Interval of the payments.

    • vatidstring

      VAT identification number.

    • taxnumberstring

      Tax number of the company.

    • buyer_reference_idstring

      Leitweg-ID or custom reference ID defined by the customer

    • taxTax

      Tax rate used for the company.

    • infostring

      Information about the company.

    • numberstring

      Customer or supplier number of the company.

    • manual_numberinteger

      Number set manually instead of the automatic number.

    • number_stringstring

      Company number as text, including prefix.

    • is_customerboolean

      The company is a customer.

    • is_supplierboolean

      The company is a supplier.

    • is_otherboolean

      The company is neither customer nor supplier.

    • is_memberboolean

      The company is a member.

    • archivedboolean

      The company is archived.

    • categoryCRMCompanyCategory

      Category of the company.

    • visible_for_customerboolean

      Whether the company is visible to the customer.

    • founding_datestring (date-time)

      Founding date of the company.

    • nace_sectionstring

      NACE section code (letter A-U)

    • nace_codestring

      NACE code (numeric like 01.11, 62.01)

    • search_stringstring

      Text that the entity can be searched by.

    • addressstring

      Address as text.

    • address_streetstring

      Street of the address.

    • address_house_numberstring

      House number of the address.

    • address_street_levelstring

      Street and house number of the address.

    • address_costring

      Care-of line of the address.

    • address_citystring

      City of the address.

    • address_zipstring

      Postal code of the address.

    • address_admin_level1string

      First administrative level of the address, e.g. the federal state.

    • address_countrystring

      Country code of the address.

    • address_full_countrystring

      Full name of the country of the address.

    • address_geo_latstring

      Latitude of the address.

    • address_geo_lngstring

      Longitude of the address.

    • address_external_provider_idstring

      field to store the external provider id of the address. e.g. Google Maps PlaceID like google:ChIJVcKw5r90sEcRhdjNq6NItqE

    • main_phonestring

      Main phone number.

    • main_faxstring

      Main fax number.

    • main_emailstring

      Main e-mail address.

    • websitestring

      Website address.

    • createdstring (date-time)

      Point in time the entity was created.

    • updatedstring (date-time)

      Point in time the entity was last updated.

    • atagsarray<AccessTag>
    • payment_typePaymentType
    • company_employee_countinteger

      Number of employees of the company.

    • company_founding_yearinteger

      Founding year of the company.

    • company_family_ownedboolean

      Whether the company is family-owned.

    • company_sales_volumestring

      Sales volume of the company.

    • company_segmentstring

      Market segment of the company.

  • personCRMPerson10

    Person the ticket belongs to.

    Show fields (81)
    • idinteger

      Primary key of the person. Internal ID.

    • first_namestring

      First name of the person.

    • last_namestring

      Last name of the person.

    • numberinteger

      Member or customer number of the person.

    • manual_numberinteger

      Number set manually instead of the automatic number.

    • number_stringstring

      Member or customer number as text, including prefix.

    • genderstring

      Gender of the person.

    • titlestring

      Academic or other title of the person.

    • positionstring

      Position or role of the person.

    • languagestring

      Preferred language of the person.

    • special_salutationstring

      Special salutation text for letters.

    • form_of_salutationstring

      Form of salutation, for example formal or informal.

    • birthdaystring (date-time)

      Birthday of the person.

    • known_allergiesstring

      Known allergies of the person.

    • confirmed_no_allergiesboolean

      Guardian confirmed that there are no known allergies.

    • allow_photosboolean

      Photos of the person may be taken and published.

    • allow_leaving_aloneboolean

      The person may leave the event alone.

    • authorized_pickupstring

      Persons who are allowed to pick up the person.

    • needs_supportboolean

      The person needs support, for example for inclusion.

    • support_descriptionstring

      Description of the support the person needs.

    • financial_supportboolean

      The person receives financial support.

    • financial_support_numberstring

      Number of the financial support.

    • municipal_supportboolean

      The person receives municipal support.

    • municipal_support_numberstring

      Number of the municipal support.

    • grade_levelinteger

      School grade level of the person.

    • school_classstring

      School class of the person.

    • start_timestring (date-time)

      Start of the membership or activity.

    • start_time_reasonstring

      Reason for the start.

    • end_timestring (date-time)

      End of the membership or activity.

    • end_time_reasonstring

      Reason for the end.

    • confirmed_gtc_timestring (date-time)

      Time the general terms and conditions were confirmed.

    • chatbot_opt_inboolean

      Einwilligung in die Nutzung des KI-Assistenten. Denormalisierter aktueller Stand - das pruefbare Protokoll steht in ChatbotConsent.

    • chatbot_opt_in_atstring (date-time)

      Time the person opted in to the chatbot.

    • chatbot_opt_in_text_versionstring

      Version des Einwilligungstextes, dem zugestimmt wurde. Weicht sie von der aktuellen Version ab, ist das Opt-in abgelaufen.

    • app_usage_statistics_opt_outboolean

      Widerspruch gegen die anonyme Nutzungsstatistik der Mitglieder-App. Die App liest ihn aus den StaticData und schickt dann nichts mehr; die gezaehlten Aufrufe selbst haben keinen Bezug zur Person.

    • crm_person_contact_dataarray<CRMPersonContactData>

      Contact data of the person, for example phone and e-mail.

    • archivedboolean

      Whether the person is archived.

    • subscribed_newsletterboolean

      Whether the person subscribed to the newsletter.

    • subscribed_magazineboolean

      Whether the person subscribed to the magazine.

    • printed_member_cardboolean

      Whether a member card has been printed for the person.

    • has_login_userboolean

      Whether the person has a login user.

    • profile_picture_urlstring

      URL of the profile picture of the person.

    • log_book_staffboolean

      Log book flag: staff.

    • log_book_staff1boolean

      Log book flag: staff, level 1.

    • log_book_staff2boolean

      Log book flag: staff, level 2.

    • log_book_memberboolean

      Log book flag: member.

    • log_book_trainerboolean

      Log book flag: trainer.

    • log_book_trainer1boolean

      Log book flag: trainer, level 1.

    • log_book_trainer2boolean

      Log book flag: trainer, level 2.

    • log_book_head_of_departmentboolean

      Log book flag: head of department.

    • log_book_supervisory_boardboolean

      Log book flag: supervisory board.

    • log_book_board_of_directorsboolean

      Log book flag: board of directors.

    • log_book_honorary_memberboolean

      Log book flag: honorary member.

    • log_book_club_card_oneboolean

      Log book flag: club card.

    • log_book_health_recoveredboolean

      Log book flag: recovered from illness.

    • log_book_health_vaccinatedboolean

      Log book flag: vaccinated.

    • log_book_health_vaccinated_additionstring

      Details of the vaccination.

    • log_book_good_conductboolean

      Log book flag: certificate of good conduct.

    • log_book_first_aidboolean

      Log book flag: first aid training.

    • log_book_measles_vaccinationboolean

      Log book flag: measles vaccination.

    • sync_lanistaboolean

      Whether the person is synchronized with Lanista.

    • categoryCRMPersonCategory

      Person category.

    • nicknamestring

      Nickname of the person.

    • preferred_color_hexstring

      Preferred color of the person as hex value.

    • avatar_tokenstring

      Token of the avatar image.

    • search_stringstring

      Text that the entity can be searched by.

    • addressstring

      Address as text.

    • address_streetstring

      Street of the address.

    • address_house_numberstring

      House number of the address.

    • address_street_levelstring

      Street and house number of the address.

    • address_costring

      Care-of line of the address.

    • address_citystring

      City of the address.

    • address_zipstring

      Postal code of the address.

    • address_admin_level1string

      First administrative level of the address, e.g. the federal state.

    • address_countrystring

      Country code of the address.

    • address_full_countrystring

      Full name of the country of the address.

    • address_geo_latstring

      Latitude of the address.

    • address_geo_lngstring

      Longitude of the address.

    • address_external_provider_idstring

      field to store the external provider id of the address. e.g. Google Maps PlaceID like google:ChIJVcKw5r90sEcRhdjNq6NItqE

    • createdstring (date-time)

      Point in time the entity was created.

    • … 2 more fields
  • jirakeystring

    Key of the linked Jira issue.

  • jiraidstring

    ID of the linked Jira issue.

  • assignedusernamestring

    Name of the assigned user, as text.

  • assigned_userUser

    User the ticket is assigned to.

    Show fields (11)
    • idinteger

      Primary key of the user. Internal ID of the login user.

    • namestring

      Display name of the user. Shown in the UI and in audit entries.

    • usernamestring

      Login name of the user. Must be unique across all users.

    • emailstring

      E-mail address of the user. Used for login notifications, password resets and as a login alias.

    • user_access_groupUserAccessGroup3

      User access group of the user. Defines the rights of the user for all scopes.

    • positioningeneralstring

      Free text describing the position or role of the user.

    • crm_personCRMPerson10

      CRM person linked to this login user. Connects the login account with the person record.

    • profile_picture_urlstring

      URL of the profile picture of the user.

    • archivedboolean

      Marks the user as archived. Archived users are kept for history and are not active.

    • require2faboolean

      Two-factor authentication is required for this user.

    • search_stringstring

      Text that the entity can be searched by.

  • createdbyusernamestring

    Name of the user who created the ticket, as text.

  • created_by_userUser

    User who created the ticket.

    Show fields (11)
    • idinteger

      Primary key of the user. Internal ID of the login user.

    • namestring

      Display name of the user. Shown in the UI and in audit entries.

    • usernamestring

      Login name of the user. Must be unique across all users.

    • emailstring

      E-mail address of the user. Used for login notifications, password resets and as a login alias.

    • user_access_groupUserAccessGroup3

      User access group of the user. Defines the rights of the user for all scopes.

    • positioningeneralstring

      Free text describing the position or role of the user.

    • crm_personCRMPerson10

      CRM person linked to this login user. Connects the login account with the person record.

    • profile_picture_urlstring

      URL of the profile picture of the user.

    • archivedboolean

      Marks the user as archived. Archived users are kept for history and are not active.

    • require2faboolean

      Two-factor authentication is required for this user.

    • search_stringstring

      Text that the entity can be searched by.

  • statusstring

    Status of the ticket as text.

  • statusidstring

    ID of the status of the ticket.

  • issuetypestring

    A type like bug, task, story

  • issuecategorystring

    A category like website, hosting, marketing

  • crm_project_category_areaCRMProjectCategoryArea

    Project category area the ticket belongs to.

    Show fields (4)
    • idinteger

      Primary key of the category area. Internal ID.

    • namestring

      Name of the area.

    • descriptionstring

      Description of the area.

    • deletedboolean

      This property is used to mark an entity as deleted / archived

  • issueprojectstring

    A project like a domain (inwendo.de) or a certain mail campaign

  • crm_projectCRMProject9

    CRM project the ticket belongs to.

    Show fields (19)
    • idinteger

      Primary key of the project. Internal ID.

    • namestring

      Name of the project.

    • closedstring (date-time)

      Time the project was closed.

    • billedstring (date-time)

      Time the project was billed.

    • numberstring

      Number of the project.

    • startstring (date-time)

      Start of the project.

    • endstring (date-time)

      End of the project.

    • descriptionstring

      Description of the project.

    • companyCRMCompany19

      Company the project belongs to.

    • internal_main_contactUser

      Internal login user who is the main contact.

    • categoryCRMProjectCategory

      Category of the project.

    • archivedboolean

      The project is archived.

    • visible_for_customerboolean

      The project is visible in the customer app.

    • name_for_customerstring

      Name of the project shown to customers.

    • invoice_emailstring

      E-mail address for invoices of the project.

    • time_report_emailstring

      E-mail address for time reports of the project.

    • search_stringstring

      Text that the entity can be searched by.

    • createdstring (date-time)

      Point in time the entity was created.

    • … 1 more fields
  • … 51 more fields
Request
curl --request GET \
  --url https://your-instance.iw-erp.de/api/crm/tickets/42 \
  --header 'x-iw-jwt-token: <TOKEN>'
Response 200 application/json
{
  "id": 42,
  "external_person_first_name": "Beispiel",
  "external_person_last_name": "Beispiel",
  "external_person_email": "lena.hartmann@example.org",
  "external_person_phone": "+49 511 123456",
  "external_person_address_city": "Hannover",
  "external_person_address_zip": "30163",
  "external_person_address_country": "DE",
  "external_company_name": "Beispiel",
  "external_company_email": "lena.hartmann@example.org"
}

Update a Ticket

PUT/api/crm/tickets/{id}

Path parameters

idrequiredstring

Request body application/json

  • dataCustomerTicket2
    Show fields (1)
    • unified_categoryUnifiedCategory11

Responses

200Update a TicketCustomerTicket3

Show fields (21)
  • satisfaction_requested_atstring

    When the customer / member was asked to rate the finished ticket; the apps offer the rating once this is set.

  • idinteger

    Primary key of the ticket. Internal ID.

  • ticket_typestring

    Type of the ticket.

  • numberinteger

    Running ticket number.

  • number_stringstring

    Ticket number as displayed to users.

  • companyCRMCompany19

    Company the ticket belongs to.

    Show fields (56)
    • idinteger

      Primary key of the company. Internal ID.

    • short_namestring

      Short name of the company.

    • company_namestring

      Legal name of the company.

    • secondary_namestring

      Second name line of the company.

    • direct_dialstring

      Direct dial number of the company.

    • invoice_emailstring

      E-mail address for invoices.

    • send_invoice_emailboolean

      Send invoices by e-mail.

    • send_invoice_letterboolean

      Send invoices by letter.

    • time_report_emailstring

      E-mail address for time reports.

    • payment_goalPaymentGoal

      Payment term of the company.

    • payment_intervalstring

      Interval of the payments.

    • vatidstring

      VAT identification number.

    • taxnumberstring

      Tax number of the company.

    • buyer_reference_idstring

      Leitweg-ID or custom reference ID defined by the customer

    • taxTax

      Tax rate used for the company.

    • infostring

      Information about the company.

    • numberstring

      Customer or supplier number of the company.

    • manual_numberinteger

      Number set manually instead of the automatic number.

    • number_stringstring

      Company number as text, including prefix.

    • is_customerboolean

      The company is a customer.

    • is_supplierboolean

      The company is a supplier.

    • is_otherboolean

      The company is neither customer nor supplier.

    • is_memberboolean

      The company is a member.

    • archivedboolean

      The company is archived.

    • categoryCRMCompanyCategory

      Category of the company.

    • visible_for_customerboolean

      Whether the company is visible to the customer.

    • founding_datestring (date-time)

      Founding date of the company.

    • nace_sectionstring

      NACE section code (letter A-U)

    • nace_codestring

      NACE code (numeric like 01.11, 62.01)

    • search_stringstring

      Text that the entity can be searched by.

    • addressstring

      Address as text.

    • address_streetstring

      Street of the address.

    • address_house_numberstring

      House number of the address.

    • address_street_levelstring

      Street and house number of the address.

    • address_costring

      Care-of line of the address.

    • address_citystring

      City of the address.

    • address_zipstring

      Postal code of the address.

    • address_admin_level1string

      First administrative level of the address, e.g. the federal state.

    • address_countrystring

      Country code of the address.

    • address_full_countrystring

      Full name of the country of the address.

    • address_geo_latstring

      Latitude of the address.

    • address_geo_lngstring

      Longitude of the address.

    • address_external_provider_idstring

      field to store the external provider id of the address. e.g. Google Maps PlaceID like google:ChIJVcKw5r90sEcRhdjNq6NItqE

    • main_phonestring

      Main phone number.

    • main_faxstring

      Main fax number.

    • main_emailstring

      Main e-mail address.

    • websitestring

      Website address.

    • createdstring (date-time)

      Point in time the entity was created.

    • updatedstring (date-time)

      Point in time the entity was last updated.

    • atagsarray<AccessTag>
    • payment_typePaymentType
    • company_employee_countinteger

      Number of employees of the company.

    • company_founding_yearinteger

      Founding year of the company.

    • company_family_ownedboolean

      Whether the company is family-owned.

    • company_sales_volumestring

      Sales volume of the company.

    • company_segmentstring

      Market segment of the company.

  • personCRMPerson10

    Person the ticket belongs to.

    Show fields (81)
    • idinteger

      Primary key of the person. Internal ID.

    • first_namestring

      First name of the person.

    • last_namestring

      Last name of the person.

    • numberinteger

      Member or customer number of the person.

    • manual_numberinteger

      Number set manually instead of the automatic number.

    • number_stringstring

      Member or customer number as text, including prefix.

    • genderstring

      Gender of the person.

    • titlestring

      Academic or other title of the person.

    • positionstring

      Position or role of the person.

    • languagestring

      Preferred language of the person.

    • special_salutationstring

      Special salutation text for letters.

    • form_of_salutationstring

      Form of salutation, for example formal or informal.

    • birthdaystring (date-time)

      Birthday of the person.

    • known_allergiesstring

      Known allergies of the person.

    • confirmed_no_allergiesboolean

      Guardian confirmed that there are no known allergies.

    • allow_photosboolean

      Photos of the person may be taken and published.

    • allow_leaving_aloneboolean

      The person may leave the event alone.

    • authorized_pickupstring

      Persons who are allowed to pick up the person.

    • needs_supportboolean

      The person needs support, for example for inclusion.

    • support_descriptionstring

      Description of the support the person needs.

    • financial_supportboolean

      The person receives financial support.

    • financial_support_numberstring

      Number of the financial support.

    • municipal_supportboolean

      The person receives municipal support.

    • municipal_support_numberstring

      Number of the municipal support.

    • grade_levelinteger

      School grade level of the person.

    • school_classstring

      School class of the person.

    • start_timestring (date-time)

      Start of the membership or activity.

    • start_time_reasonstring

      Reason for the start.

    • end_timestring (date-time)

      End of the membership or activity.

    • end_time_reasonstring

      Reason for the end.

    • confirmed_gtc_timestring (date-time)

      Time the general terms and conditions were confirmed.

    • chatbot_opt_inboolean

      Einwilligung in die Nutzung des KI-Assistenten. Denormalisierter aktueller Stand - das pruefbare Protokoll steht in ChatbotConsent.

    • chatbot_opt_in_atstring (date-time)

      Time the person opted in to the chatbot.

    • chatbot_opt_in_text_versionstring

      Version des Einwilligungstextes, dem zugestimmt wurde. Weicht sie von der aktuellen Version ab, ist das Opt-in abgelaufen.

    • app_usage_statistics_opt_outboolean

      Widerspruch gegen die anonyme Nutzungsstatistik der Mitglieder-App. Die App liest ihn aus den StaticData und schickt dann nichts mehr; die gezaehlten Aufrufe selbst haben keinen Bezug zur Person.

    • crm_person_contact_dataarray<CRMPersonContactData>

      Contact data of the person, for example phone and e-mail.

    • archivedboolean

      Whether the person is archived.

    • subscribed_newsletterboolean

      Whether the person subscribed to the newsletter.

    • subscribed_magazineboolean

      Whether the person subscribed to the magazine.

    • printed_member_cardboolean

      Whether a member card has been printed for the person.

    • has_login_userboolean

      Whether the person has a login user.

    • profile_picture_urlstring

      URL of the profile picture of the person.

    • log_book_staffboolean

      Log book flag: staff.

    • log_book_staff1boolean

      Log book flag: staff, level 1.

    • log_book_staff2boolean

      Log book flag: staff, level 2.

    • log_book_memberboolean

      Log book flag: member.

    • log_book_trainerboolean

      Log book flag: trainer.

    • log_book_trainer1boolean

      Log book flag: trainer, level 1.

    • log_book_trainer2boolean

      Log book flag: trainer, level 2.

    • log_book_head_of_departmentboolean

      Log book flag: head of department.

    • log_book_supervisory_boardboolean

      Log book flag: supervisory board.

    • log_book_board_of_directorsboolean

      Log book flag: board of directors.

    • log_book_honorary_memberboolean

      Log book flag: honorary member.

    • log_book_club_card_oneboolean

      Log book flag: club card.

    • log_book_health_recoveredboolean

      Log book flag: recovered from illness.

    • log_book_health_vaccinatedboolean

      Log book flag: vaccinated.

    • log_book_health_vaccinated_additionstring

      Details of the vaccination.

    • log_book_good_conductboolean

      Log book flag: certificate of good conduct.

    • log_book_first_aidboolean

      Log book flag: first aid training.

    • log_book_measles_vaccinationboolean

      Log book flag: measles vaccination.

    • sync_lanistaboolean

      Whether the person is synchronized with Lanista.

    • categoryCRMPersonCategory

      Person category.

    • nicknamestring

      Nickname of the person.

    • preferred_color_hexstring

      Preferred color of the person as hex value.

    • avatar_tokenstring

      Token of the avatar image.

    • search_stringstring

      Text that the entity can be searched by.

    • addressstring

      Address as text.

    • address_streetstring

      Street of the address.

    • address_house_numberstring

      House number of the address.

    • address_street_levelstring

      Street and house number of the address.

    • address_costring

      Care-of line of the address.

    • address_citystring

      City of the address.

    • address_zipstring

      Postal code of the address.

    • address_admin_level1string

      First administrative level of the address, e.g. the federal state.

    • address_countrystring

      Country code of the address.

    • address_full_countrystring

      Full name of the country of the address.

    • address_geo_latstring

      Latitude of the address.

    • address_geo_lngstring

      Longitude of the address.

    • address_external_provider_idstring

      field to store the external provider id of the address. e.g. Google Maps PlaceID like google:ChIJVcKw5r90sEcRhdjNq6NItqE

    • createdstring (date-time)

      Point in time the entity was created.

    • … 2 more fields
  • jirakeystring

    Key of the linked Jira issue.

  • jiraidstring

    ID of the linked Jira issue.

  • assignedusernamestring

    Name of the assigned user, as text.

  • assigned_userUser

    User the ticket is assigned to.

    Show fields (11)
    • idinteger

      Primary key of the user. Internal ID of the login user.

    • namestring

      Display name of the user. Shown in the UI and in audit entries.

    • usernamestring

      Login name of the user. Must be unique across all users.

    • emailstring

      E-mail address of the user. Used for login notifications, password resets and as a login alias.

    • user_access_groupUserAccessGroup3

      User access group of the user. Defines the rights of the user for all scopes.

    • positioningeneralstring

      Free text describing the position or role of the user.

    • crm_personCRMPerson10

      CRM person linked to this login user. Connects the login account with the person record.

    • profile_picture_urlstring

      URL of the profile picture of the user.

    • archivedboolean

      Marks the user as archived. Archived users are kept for history and are not active.

    • require2faboolean

      Two-factor authentication is required for this user.

    • search_stringstring

      Text that the entity can be searched by.

  • createdbyusernamestring

    Name of the user who created the ticket, as text.

  • created_by_userUser

    User who created the ticket.

    Show fields (11)
    • idinteger

      Primary key of the user. Internal ID of the login user.

    • namestring

      Display name of the user. Shown in the UI and in audit entries.

    • usernamestring

      Login name of the user. Must be unique across all users.

    • emailstring

      E-mail address of the user. Used for login notifications, password resets and as a login alias.

    • user_access_groupUserAccessGroup3

      User access group of the user. Defines the rights of the user for all scopes.

    • positioningeneralstring

      Free text describing the position or role of the user.

    • crm_personCRMPerson10

      CRM person linked to this login user. Connects the login account with the person record.

    • profile_picture_urlstring

      URL of the profile picture of the user.

    • archivedboolean

      Marks the user as archived. Archived users are kept for history and are not active.

    • require2faboolean

      Two-factor authentication is required for this user.

    • search_stringstring

      Text that the entity can be searched by.

  • statusstring

    Status of the ticket as text.

  • statusidstring

    ID of the status of the ticket.

  • issuetypestring

    A type like bug, task, story

  • issuecategorystring

    A category like website, hosting, marketing

  • crm_project_category_areaCRMProjectCategoryArea

    Project category area the ticket belongs to.

    Show fields (4)
    • idinteger

      Primary key of the category area. Internal ID.

    • namestring

      Name of the area.

    • descriptionstring

      Description of the area.

    • deletedboolean

      This property is used to mark an entity as deleted / archived

  • issueprojectstring

    A project like a domain (inwendo.de) or a certain mail campaign

  • crm_projectCRMProject9

    CRM project the ticket belongs to.

    Show fields (19)
    • idinteger

      Primary key of the project. Internal ID.

    • namestring

      Name of the project.

    • closedstring (date-time)

      Time the project was closed.

    • billedstring (date-time)

      Time the project was billed.

    • numberstring

      Number of the project.

    • startstring (date-time)

      Start of the project.

    • endstring (date-time)

      End of the project.

    • descriptionstring

      Description of the project.

    • companyCRMCompany19

      Company the project belongs to.

    • internal_main_contactUser

      Internal login user who is the main contact.

    • categoryCRMProjectCategory

      Category of the project.

    • archivedboolean

      The project is archived.

    • visible_for_customerboolean

      The project is visible in the customer app.

    • name_for_customerstring

      Name of the project shown to customers.

    • invoice_emailstring

      E-mail address for invoices of the project.

    • time_report_emailstring

      E-mail address for time reports of the project.

    • search_stringstring

      Text that the entity can be searched by.

    • createdstring (date-time)

      Point in time the entity was created.

    • … 1 more fields
  • … 51 more fields
Request
curl --request PUT \
  --url https://your-instance.iw-erp.de/api/crm/tickets/42 \
  --header 'content-type: application/json' \
  --header 'x-iw-jwt-token: <TOKEN>' \
  --data '
{
  "data": {
    "unified_category": {
      "address_street": "Jakobistr. 39",
      "address_city": "Hannover",
      "address_zip": "30163",
      "address_country": "DE",
      "address_full_country": "DE",
      "main_phone": "+49 511 123456"
    }
  }
}
'
Response 200 application/json
{
  "id": 42,
  "external_person_first_name": "Beispiel",
  "external_person_last_name": "Beispiel",
  "external_person_email": "lena.hartmann@example.org",
  "external_person_phone": "+49 511 123456",
  "external_person_address_city": "Hannover",
  "external_person_address_zip": "30163",
  "external_person_address_country": "DE",
  "external_company_name": "Beispiel",
  "external_company_email": "lena.hartmann@example.org"
}

Update a Ticket

PATCH/api/crm/tickets/{id}

Path parameters

idrequiredstring

Request body application/json

  • dataCustomerTicket2
    Show fields (1)
    • unified_categoryUnifiedCategory11

Responses

200Update a TicketCustomerTicket3

Show fields (21)
  • satisfaction_requested_atstring

    When the customer / member was asked to rate the finished ticket; the apps offer the rating once this is set.

  • idinteger

    Primary key of the ticket. Internal ID.

  • ticket_typestring

    Type of the ticket.

  • numberinteger

    Running ticket number.

  • number_stringstring

    Ticket number as displayed to users.

  • companyCRMCompany19

    Company the ticket belongs to.

    Show fields (56)
    • idinteger

      Primary key of the company. Internal ID.

    • short_namestring

      Short name of the company.

    • company_namestring

      Legal name of the company.

    • secondary_namestring

      Second name line of the company.

    • direct_dialstring

      Direct dial number of the company.

    • invoice_emailstring

      E-mail address for invoices.

    • send_invoice_emailboolean

      Send invoices by e-mail.

    • send_invoice_letterboolean

      Send invoices by letter.

    • time_report_emailstring

      E-mail address for time reports.

    • payment_goalPaymentGoal

      Payment term of the company.

    • payment_intervalstring

      Interval of the payments.

    • vatidstring

      VAT identification number.

    • taxnumberstring

      Tax number of the company.

    • buyer_reference_idstring

      Leitweg-ID or custom reference ID defined by the customer

    • taxTax

      Tax rate used for the company.

    • infostring

      Information about the company.

    • numberstring

      Customer or supplier number of the company.

    • manual_numberinteger

      Number set manually instead of the automatic number.

    • number_stringstring

      Company number as text, including prefix.

    • is_customerboolean

      The company is a customer.

    • is_supplierboolean

      The company is a supplier.

    • is_otherboolean

      The company is neither customer nor supplier.

    • is_memberboolean

      The company is a member.

    • archivedboolean

      The company is archived.

    • categoryCRMCompanyCategory

      Category of the company.

    • visible_for_customerboolean

      Whether the company is visible to the customer.

    • founding_datestring (date-time)

      Founding date of the company.

    • nace_sectionstring

      NACE section code (letter A-U)

    • nace_codestring

      NACE code (numeric like 01.11, 62.01)

    • search_stringstring

      Text that the entity can be searched by.

    • addressstring

      Address as text.

    • address_streetstring

      Street of the address.

    • address_house_numberstring

      House number of the address.

    • address_street_levelstring

      Street and house number of the address.

    • address_costring

      Care-of line of the address.

    • address_citystring

      City of the address.

    • address_zipstring

      Postal code of the address.

    • address_admin_level1string

      First administrative level of the address, e.g. the federal state.

    • address_countrystring

      Country code of the address.

    • address_full_countrystring

      Full name of the country of the address.

    • address_geo_latstring

      Latitude of the address.

    • address_geo_lngstring

      Longitude of the address.

    • address_external_provider_idstring

      field to store the external provider id of the address. e.g. Google Maps PlaceID like google:ChIJVcKw5r90sEcRhdjNq6NItqE

    • main_phonestring

      Main phone number.

    • main_faxstring

      Main fax number.

    • main_emailstring

      Main e-mail address.

    • websitestring

      Website address.

    • createdstring (date-time)

      Point in time the entity was created.

    • updatedstring (date-time)

      Point in time the entity was last updated.

    • atagsarray<AccessTag>
    • payment_typePaymentType
    • company_employee_countinteger

      Number of employees of the company.

    • company_founding_yearinteger

      Founding year of the company.

    • company_family_ownedboolean

      Whether the company is family-owned.

    • company_sales_volumestring

      Sales volume of the company.

    • company_segmentstring

      Market segment of the company.

  • personCRMPerson10

    Person the ticket belongs to.

    Show fields (81)
    • idinteger

      Primary key of the person. Internal ID.

    • first_namestring

      First name of the person.

    • last_namestring

      Last name of the person.

    • numberinteger

      Member or customer number of the person.

    • manual_numberinteger

      Number set manually instead of the automatic number.

    • number_stringstring

      Member or customer number as text, including prefix.

    • genderstring

      Gender of the person.

    • titlestring

      Academic or other title of the person.

    • positionstring

      Position or role of the person.

    • languagestring

      Preferred language of the person.

    • special_salutationstring

      Special salutation text for letters.

    • form_of_salutationstring

      Form of salutation, for example formal or informal.

    • birthdaystring (date-time)

      Birthday of the person.

    • known_allergiesstring

      Known allergies of the person.

    • confirmed_no_allergiesboolean

      Guardian confirmed that there are no known allergies.

    • allow_photosboolean

      Photos of the person may be taken and published.

    • allow_leaving_aloneboolean

      The person may leave the event alone.

    • authorized_pickupstring

      Persons who are allowed to pick up the person.

    • needs_supportboolean

      The person needs support, for example for inclusion.

    • support_descriptionstring

      Description of the support the person needs.

    • financial_supportboolean

      The person receives financial support.

    • financial_support_numberstring

      Number of the financial support.

    • municipal_supportboolean

      The person receives municipal support.

    • municipal_support_numberstring

      Number of the municipal support.

    • grade_levelinteger

      School grade level of the person.

    • school_classstring

      School class of the person.

    • start_timestring (date-time)

      Start of the membership or activity.

    • start_time_reasonstring

      Reason for the start.

    • end_timestring (date-time)

      End of the membership or activity.

    • end_time_reasonstring

      Reason for the end.

    • confirmed_gtc_timestring (date-time)

      Time the general terms and conditions were confirmed.

    • chatbot_opt_inboolean

      Einwilligung in die Nutzung des KI-Assistenten. Denormalisierter aktueller Stand - das pruefbare Protokoll steht in ChatbotConsent.

    • chatbot_opt_in_atstring (date-time)

      Time the person opted in to the chatbot.

    • chatbot_opt_in_text_versionstring

      Version des Einwilligungstextes, dem zugestimmt wurde. Weicht sie von der aktuellen Version ab, ist das Opt-in abgelaufen.

    • app_usage_statistics_opt_outboolean

      Widerspruch gegen die anonyme Nutzungsstatistik der Mitglieder-App. Die App liest ihn aus den StaticData und schickt dann nichts mehr; die gezaehlten Aufrufe selbst haben keinen Bezug zur Person.

    • crm_person_contact_dataarray<CRMPersonContactData>

      Contact data of the person, for example phone and e-mail.

    • archivedboolean

      Whether the person is archived.

    • subscribed_newsletterboolean

      Whether the person subscribed to the newsletter.

    • subscribed_magazineboolean

      Whether the person subscribed to the magazine.

    • printed_member_cardboolean

      Whether a member card has been printed for the person.

    • has_login_userboolean

      Whether the person has a login user.

    • profile_picture_urlstring

      URL of the profile picture of the person.

    • log_book_staffboolean

      Log book flag: staff.

    • log_book_staff1boolean

      Log book flag: staff, level 1.

    • log_book_staff2boolean

      Log book flag: staff, level 2.

    • log_book_memberboolean

      Log book flag: member.

    • log_book_trainerboolean

      Log book flag: trainer.

    • log_book_trainer1boolean

      Log book flag: trainer, level 1.

    • log_book_trainer2boolean

      Log book flag: trainer, level 2.

    • log_book_head_of_departmentboolean

      Log book flag: head of department.

    • log_book_supervisory_boardboolean

      Log book flag: supervisory board.

    • log_book_board_of_directorsboolean

      Log book flag: board of directors.

    • log_book_honorary_memberboolean

      Log book flag: honorary member.

    • log_book_club_card_oneboolean

      Log book flag: club card.

    • log_book_health_recoveredboolean

      Log book flag: recovered from illness.

    • log_book_health_vaccinatedboolean

      Log book flag: vaccinated.

    • log_book_health_vaccinated_additionstring

      Details of the vaccination.

    • log_book_good_conductboolean

      Log book flag: certificate of good conduct.

    • log_book_first_aidboolean

      Log book flag: first aid training.

    • log_book_measles_vaccinationboolean

      Log book flag: measles vaccination.

    • sync_lanistaboolean

      Whether the person is synchronized with Lanista.

    • categoryCRMPersonCategory

      Person category.

    • nicknamestring

      Nickname of the person.

    • preferred_color_hexstring

      Preferred color of the person as hex value.

    • avatar_tokenstring

      Token of the avatar image.

    • search_stringstring

      Text that the entity can be searched by.

    • addressstring

      Address as text.

    • address_streetstring

      Street of the address.

    • address_house_numberstring

      House number of the address.

    • address_street_levelstring

      Street and house number of the address.

    • address_costring

      Care-of line of the address.

    • address_citystring

      City of the address.

    • address_zipstring

      Postal code of the address.

    • address_admin_level1string

      First administrative level of the address, e.g. the federal state.

    • address_countrystring

      Country code of the address.

    • address_full_countrystring

      Full name of the country of the address.

    • address_geo_latstring

      Latitude of the address.

    • address_geo_lngstring

      Longitude of the address.

    • address_external_provider_idstring

      field to store the external provider id of the address. e.g. Google Maps PlaceID like google:ChIJVcKw5r90sEcRhdjNq6NItqE

    • createdstring (date-time)

      Point in time the entity was created.

    • … 2 more fields
  • jirakeystring

    Key of the linked Jira issue.

  • jiraidstring

    ID of the linked Jira issue.

  • assignedusernamestring

    Name of the assigned user, as text.

  • assigned_userUser

    User the ticket is assigned to.

    Show fields (11)
    • idinteger

      Primary key of the user. Internal ID of the login user.

    • namestring

      Display name of the user. Shown in the UI and in audit entries.

    • usernamestring

      Login name of the user. Must be unique across all users.

    • emailstring

      E-mail address of the user. Used for login notifications, password resets and as a login alias.

    • user_access_groupUserAccessGroup3

      User access group of the user. Defines the rights of the user for all scopes.

    • positioningeneralstring

      Free text describing the position or role of the user.

    • crm_personCRMPerson10

      CRM person linked to this login user. Connects the login account with the person record.

    • profile_picture_urlstring

      URL of the profile picture of the user.

    • archivedboolean

      Marks the user as archived. Archived users are kept for history and are not active.

    • require2faboolean

      Two-factor authentication is required for this user.

    • search_stringstring

      Text that the entity can be searched by.

  • createdbyusernamestring

    Name of the user who created the ticket, as text.

  • created_by_userUser

    User who created the ticket.

    Show fields (11)
    • idinteger

      Primary key of the user. Internal ID of the login user.

    • namestring

      Display name of the user. Shown in the UI and in audit entries.

    • usernamestring

      Login name of the user. Must be unique across all users.

    • emailstring

      E-mail address of the user. Used for login notifications, password resets and as a login alias.

    • user_access_groupUserAccessGroup3

      User access group of the user. Defines the rights of the user for all scopes.

    • positioningeneralstring

      Free text describing the position or role of the user.

    • crm_personCRMPerson10

      CRM person linked to this login user. Connects the login account with the person record.

    • profile_picture_urlstring

      URL of the profile picture of the user.

    • archivedboolean

      Marks the user as archived. Archived users are kept for history and are not active.

    • require2faboolean

      Two-factor authentication is required for this user.

    • search_stringstring

      Text that the entity can be searched by.

  • statusstring

    Status of the ticket as text.

  • statusidstring

    ID of the status of the ticket.

  • issuetypestring

    A type like bug, task, story

  • issuecategorystring

    A category like website, hosting, marketing

  • crm_project_category_areaCRMProjectCategoryArea

    Project category area the ticket belongs to.

    Show fields (4)
    • idinteger

      Primary key of the category area. Internal ID.

    • namestring

      Name of the area.

    • descriptionstring

      Description of the area.

    • deletedboolean

      This property is used to mark an entity as deleted / archived

  • issueprojectstring

    A project like a domain (inwendo.de) or a certain mail campaign

  • crm_projectCRMProject9

    CRM project the ticket belongs to.

    Show fields (19)
    • idinteger

      Primary key of the project. Internal ID.

    • namestring

      Name of the project.

    • closedstring (date-time)

      Time the project was closed.

    • billedstring (date-time)

      Time the project was billed.

    • numberstring

      Number of the project.

    • startstring (date-time)

      Start of the project.

    • endstring (date-time)

      End of the project.

    • descriptionstring

      Description of the project.

    • companyCRMCompany19

      Company the project belongs to.

    • internal_main_contactUser

      Internal login user who is the main contact.

    • categoryCRMProjectCategory

      Category of the project.

    • archivedboolean

      The project is archived.

    • visible_for_customerboolean

      The project is visible in the customer app.

    • name_for_customerstring

      Name of the project shown to customers.

    • invoice_emailstring

      E-mail address for invoices of the project.

    • time_report_emailstring

      E-mail address for time reports of the project.

    • search_stringstring

      Text that the entity can be searched by.

    • createdstring (date-time)

      Point in time the entity was created.

    • … 1 more fields
  • … 51 more fields
Request
curl --request PATCH \
  --url https://your-instance.iw-erp.de/api/crm/tickets/42 \
  --header 'content-type: application/json' \
  --header 'x-iw-jwt-token: <TOKEN>' \
  --data '
{
  "data": {
    "unified_category": {
      "address_street": "Jakobistr. 39",
      "address_city": "Hannover",
      "address_zip": "30163",
      "address_country": "DE",
      "address_full_country": "DE",
      "main_phone": "+49 511 123456"
    }
  }
}
'
Response 200 application/json
{
  "id": 42,
  "external_person_first_name": "Beispiel",
  "external_person_last_name": "Beispiel",
  "external_person_email": "lena.hartmann@example.org",
  "external_person_phone": "+49 511 123456",
  "external_person_address_city": "Hannover",
  "external_person_address_zip": "30163",
  "external_person_address_country": "DE",
  "external_company_name": "Beispiel",
  "external_company_email": "lena.hartmann@example.org"
}

Create several sick tickets ("Massen-Krankmeldung") at once and return a result per row.

POST/api/crm/tickets/sick_bulk

Every row is handled like one row of the sick ticket CSV import (SickTicketImportService): it accepts the same column keys (PERSON_IDENTIFIER or name + school + class, START_DATE, END_DATE, SICK_TICKET_DESCRIPTION and their aliases in IwSharedDataArrayHandler), applies the same timeframe rules and skips the same duplicates. Rows are independent: a skipped row does not stop the others.

Request body application/json

  • dataobject
    Show fields (1)
    • rowsarray<object>

      Rows with the column keys of the sick ticket import (max. 500)

Responses

200The result of every row in the order of the requestobject

Show fields (3)
  • createdinteger
  • skippedinteger
  • rowsarray<object>
    Show fields (5)
    • rowinteger

      Index of the row in the request, starting at 0

    • statusstring

      Allowed: created empty_row unknown_category missing_category missing_person invalid_timeframe duplicate

    • ticket_idinteger
    • person_idinteger
    • person_namestring
Request
curl --request POST \
  --url https://your-instance.iw-erp.de/api/crm/tickets/sick_bulk \
  --header 'content-type: application/json' \
  --header 'x-iw-jwt-token: <TOKEN>' \
  --data '{}'
Response 200 application/json
{
  "created": 1,
  "skipped": 1,
  "rows": [
    {
      "person_name": "Beispiel",
      "row": 1,
      "status": "created",
      "ticket_id": 42,
      "person_id": 42
    }
  ]
}

Create the follow-up ticket ("Wiedervorlage") the AI suggested for this ticket.

POST/api/crm/tickets/{id}/ai_follow_up

The suggestion comes from the opt-in AI follow-up detection (inwendo_crm_ticket_ai_follow_up_enabled). Creating a ticket needs the full ticket scope.

Path parameters

idrequiredstring

Request body application/json

  • dataobject
    Show fields (2)
    • sourcestring

      Key of the suggestion in ai_follow_ups

    • duestring

      Optional other due date

Responses

200The created follow-up ticketCustomerTicket4

Show fields (21)
  • satisfaction_requested_atstring

    When the customer / member was asked to rate the finished ticket; the apps offer the rating once this is set.

  • idinteger

    Primary key of the ticket. Internal ID.

  • ticket_typestring

    Type of the ticket.

  • numberinteger

    Running ticket number.

  • number_stringstring

    Ticket number as displayed to users.

  • companyCRMCompany

    Company the ticket belongs to.

    Show fields (55)
    • idinteger

      Primary key of the company. Internal ID.

    • short_namestring

      Short name of the company.

    • company_namestring

      Legal name of the company.

    • secondary_namestring

      Second name line of the company.

    • direct_dialstring

      Direct dial number of the company.

    • invoice_emailstring

      E-mail address for invoices.

    • send_invoice_emailboolean

      Send invoices by e-mail.

    • send_invoice_letterboolean

      Send invoices by letter.

    • time_report_emailstring

      E-mail address for time reports.

    • payment_goalPaymentGoal

      Payment term of the company.

    • payment_intervalstring

      Interval of the payments.

    • vatidstring

      VAT identification number.

    • taxnumberstring

      Tax number of the company.

    • buyer_reference_idstring

      Leitweg-ID or custom reference ID defined by the customer

    • taxTax

      Tax rate used for the company.

    • infostring

      Information about the company.

    • numberstring

      Customer or supplier number of the company.

    • manual_numberinteger

      Number set manually instead of the automatic number.

    • number_stringstring

      Company number as text, including prefix.

    • is_customerboolean

      The company is a customer.

    • is_supplierboolean

      The company is a supplier.

    • is_otherboolean

      The company is neither customer nor supplier.

    • is_memberboolean

      The company is a member.

    • archivedboolean

      The company is archived.

    • categoryCRMCompanyCategory

      Category of the company.

    • visible_for_customerboolean

      Whether the company is visible to the customer.

    • founding_datestring (date-time)

      Founding date of the company.

    • nace_sectionstring

      NACE section code (letter A-U)

    • nace_codestring

      NACE code (numeric like 01.11, 62.01)

    • search_stringstring

      Text that the entity can be searched by.

    • addressstring

      Address as text.

    • address_streetstring

      Street of the address.

    • address_house_numberstring

      House number of the address.

    • address_street_levelstring

      Street and house number of the address.

    • address_costring

      Care-of line of the address.

    • address_citystring

      City of the address.

    • address_zipstring

      Postal code of the address.

    • address_admin_level1string

      First administrative level of the address, e.g. the federal state.

    • address_countrystring

      Country code of the address.

    • address_full_countrystring

      Full name of the country of the address.

    • address_geo_latstring

      Latitude of the address.

    • address_geo_lngstring

      Longitude of the address.

    • address_external_provider_idstring

      field to store the external provider id of the address. e.g. Google Maps PlaceID like google:ChIJVcKw5r90sEcRhdjNq6NItqE

    • main_phonestring

      Main phone number.

    • main_faxstring

      Main fax number.

    • main_emailstring

      Main e-mail address.

    • websitestring

      Website address.

    • createdstring (date-time)

      Point in time the entity was created.

    • updatedstring (date-time)

      Point in time the entity was last updated.

    • payment_typePaymentType
    • company_employee_countinteger

      Number of employees of the company.

    • company_founding_yearinteger

      Founding year of the company.

    • company_family_ownedboolean

      Whether the company is family-owned.

    • company_sales_volumestring

      Sales volume of the company.

    • company_segmentstring

      Market segment of the company.

  • personCRMPerson10

    Person the ticket belongs to.

    Show fields (81)
    • idinteger

      Primary key of the person. Internal ID.

    • first_namestring

      First name of the person.

    • last_namestring

      Last name of the person.

    • numberinteger

      Member or customer number of the person.

    • manual_numberinteger

      Number set manually instead of the automatic number.

    • number_stringstring

      Member or customer number as text, including prefix.

    • genderstring

      Gender of the person.

    • titlestring

      Academic or other title of the person.

    • positionstring

      Position or role of the person.

    • languagestring

      Preferred language of the person.

    • special_salutationstring

      Special salutation text for letters.

    • form_of_salutationstring

      Form of salutation, for example formal or informal.

    • birthdaystring (date-time)

      Birthday of the person.

    • known_allergiesstring

      Known allergies of the person.

    • confirmed_no_allergiesboolean

      Guardian confirmed that there are no known allergies.

    • allow_photosboolean

      Photos of the person may be taken and published.

    • allow_leaving_aloneboolean

      The person may leave the event alone.

    • authorized_pickupstring

      Persons who are allowed to pick up the person.

    • needs_supportboolean

      The person needs support, for example for inclusion.

    • support_descriptionstring

      Description of the support the person needs.

    • financial_supportboolean

      The person receives financial support.

    • financial_support_numberstring

      Number of the financial support.

    • municipal_supportboolean

      The person receives municipal support.

    • municipal_support_numberstring

      Number of the municipal support.

    • grade_levelinteger

      School grade level of the person.

    • school_classstring

      School class of the person.

    • start_timestring (date-time)

      Start of the membership or activity.

    • start_time_reasonstring

      Reason for the start.

    • end_timestring (date-time)

      End of the membership or activity.

    • end_time_reasonstring

      Reason for the end.

    • confirmed_gtc_timestring (date-time)

      Time the general terms and conditions were confirmed.

    • chatbot_opt_inboolean

      Einwilligung in die Nutzung des KI-Assistenten. Denormalisierter aktueller Stand - das pruefbare Protokoll steht in ChatbotConsent.

    • chatbot_opt_in_atstring (date-time)

      Time the person opted in to the chatbot.

    • chatbot_opt_in_text_versionstring

      Version des Einwilligungstextes, dem zugestimmt wurde. Weicht sie von der aktuellen Version ab, ist das Opt-in abgelaufen.

    • app_usage_statistics_opt_outboolean

      Widerspruch gegen die anonyme Nutzungsstatistik der Mitglieder-App. Die App liest ihn aus den StaticData und schickt dann nichts mehr; die gezaehlten Aufrufe selbst haben keinen Bezug zur Person.

    • crm_person_contact_dataarray<CRMPersonContactData>

      Contact data of the person, for example phone and e-mail.

    • archivedboolean

      Whether the person is archived.

    • subscribed_newsletterboolean

      Whether the person subscribed to the newsletter.

    • subscribed_magazineboolean

      Whether the person subscribed to the magazine.

    • printed_member_cardboolean

      Whether a member card has been printed for the person.

    • has_login_userboolean

      Whether the person has a login user.

    • profile_picture_urlstring

      URL of the profile picture of the person.

    • log_book_staffboolean

      Log book flag: staff.

    • log_book_staff1boolean

      Log book flag: staff, level 1.

    • log_book_staff2boolean

      Log book flag: staff, level 2.

    • log_book_memberboolean

      Log book flag: member.

    • log_book_trainerboolean

      Log book flag: trainer.

    • log_book_trainer1boolean

      Log book flag: trainer, level 1.

    • log_book_trainer2boolean

      Log book flag: trainer, level 2.

    • log_book_head_of_departmentboolean

      Log book flag: head of department.

    • log_book_supervisory_boardboolean

      Log book flag: supervisory board.

    • log_book_board_of_directorsboolean

      Log book flag: board of directors.

    • log_book_honorary_memberboolean

      Log book flag: honorary member.

    • log_book_club_card_oneboolean

      Log book flag: club card.

    • log_book_health_recoveredboolean

      Log book flag: recovered from illness.

    • log_book_health_vaccinatedboolean

      Log book flag: vaccinated.

    • log_book_health_vaccinated_additionstring

      Details of the vaccination.

    • log_book_good_conductboolean

      Log book flag: certificate of good conduct.

    • log_book_first_aidboolean

      Log book flag: first aid training.

    • log_book_measles_vaccinationboolean

      Log book flag: measles vaccination.

    • sync_lanistaboolean

      Whether the person is synchronized with Lanista.

    • categoryCRMPersonCategory

      Person category.

    • nicknamestring

      Nickname of the person.

    • preferred_color_hexstring

      Preferred color of the person as hex value.

    • avatar_tokenstring

      Token of the avatar image.

    • search_stringstring

      Text that the entity can be searched by.

    • addressstring

      Address as text.

    • address_streetstring

      Street of the address.

    • address_house_numberstring

      House number of the address.

    • address_street_levelstring

      Street and house number of the address.

    • address_costring

      Care-of line of the address.

    • address_citystring

      City of the address.

    • address_zipstring

      Postal code of the address.

    • address_admin_level1string

      First administrative level of the address, e.g. the federal state.

    • address_countrystring

      Country code of the address.

    • address_full_countrystring

      Full name of the country of the address.

    • address_geo_latstring

      Latitude of the address.

    • address_geo_lngstring

      Longitude of the address.

    • address_external_provider_idstring

      field to store the external provider id of the address. e.g. Google Maps PlaceID like google:ChIJVcKw5r90sEcRhdjNq6NItqE

    • createdstring (date-time)

      Point in time the entity was created.

    • … 2 more fields
  • jirakeystring

    Key of the linked Jira issue.

  • jiraidstring

    ID of the linked Jira issue.

  • assignedusernamestring

    Name of the assigned user, as text.

  • assigned_userUser

    User the ticket is assigned to.

    Show fields (11)
    • idinteger

      Primary key of the user. Internal ID of the login user.

    • namestring

      Display name of the user. Shown in the UI and in audit entries.

    • usernamestring

      Login name of the user. Must be unique across all users.

    • emailstring

      E-mail address of the user. Used for login notifications, password resets and as a login alias.

    • user_access_groupUserAccessGroup3

      User access group of the user. Defines the rights of the user for all scopes.

    • positioningeneralstring

      Free text describing the position or role of the user.

    • crm_personCRMPerson10

      CRM person linked to this login user. Connects the login account with the person record.

    • profile_picture_urlstring

      URL of the profile picture of the user.

    • archivedboolean

      Marks the user as archived. Archived users are kept for history and are not active.

    • require2faboolean

      Two-factor authentication is required for this user.

    • search_stringstring

      Text that the entity can be searched by.

  • createdbyusernamestring

    Name of the user who created the ticket, as text.

  • created_by_userUser

    User who created the ticket.

    Show fields (11)
    • idinteger

      Primary key of the user. Internal ID of the login user.

    • namestring

      Display name of the user. Shown in the UI and in audit entries.

    • usernamestring

      Login name of the user. Must be unique across all users.

    • emailstring

      E-mail address of the user. Used for login notifications, password resets and as a login alias.

    • user_access_groupUserAccessGroup3

      User access group of the user. Defines the rights of the user for all scopes.

    • positioningeneralstring

      Free text describing the position or role of the user.

    • crm_personCRMPerson10

      CRM person linked to this login user. Connects the login account with the person record.

    • profile_picture_urlstring

      URL of the profile picture of the user.

    • archivedboolean

      Marks the user as archived. Archived users are kept for history and are not active.

    • require2faboolean

      Two-factor authentication is required for this user.

    • search_stringstring

      Text that the entity can be searched by.

  • statusstring

    Status of the ticket as text.

  • statusidstring

    ID of the status of the ticket.

  • issuetypestring

    A type like bug, task, story

  • issuecategorystring

    A category like website, hosting, marketing

  • crm_project_category_areaCRMProjectCategoryArea

    Project category area the ticket belongs to.

    Show fields (4)
    • idinteger

      Primary key of the category area. Internal ID.

    • namestring

      Name of the area.

    • descriptionstring

      Description of the area.

    • deletedboolean

      This property is used to mark an entity as deleted / archived

  • issueprojectstring

    A project like a domain (inwendo.de) or a certain mail campaign

  • crm_projectCRMProject10

    CRM project the ticket belongs to.

    Show fields (19)
    • idinteger

      Primary key of the project. Internal ID.

    • namestring

      Name of the project.

    • closedstring (date-time)

      Time the project was closed.

    • billedstring (date-time)

      Time the project was billed.

    • numberstring

      Number of the project.

    • startstring (date-time)

      Start of the project.

    • endstring (date-time)

      End of the project.

    • descriptionstring

      Description of the project.

    • companyCRMCompany

      Company the project belongs to.

    • internal_main_contactUser

      Internal login user who is the main contact.

    • categoryCRMProjectCategory

      Category of the project.

    • archivedboolean

      The project is archived.

    • visible_for_customerboolean

      The project is visible in the customer app.

    • name_for_customerstring

      Name of the project shown to customers.

    • invoice_emailstring

      E-mail address for invoices of the project.

    • time_report_emailstring

      E-mail address for time reports of the project.

    • search_stringstring

      Text that the entity can be searched by.

    • createdstring (date-time)

      Point in time the entity was created.

    • updatedstring (date-time)

      Point in time the entity was last updated.

  • … 51 more fields
Request
curl --request POST \
  --url https://your-instance.iw-erp.de/api/crm/tickets/42/ai_follow_up \
  --header 'content-type: application/json' \
  --header 'x-iw-jwt-token: <TOKEN>' \
  --data '
{
  "data": {
    "source": "comment_12",
    "due": "2026-03-15 09:00:00"
  }
}
'
Response 200 application/json
{
  "id": 42,
  "external_person_first_name": "Beispiel",
  "external_person_last_name": "Beispiel",
  "external_person_email": "lena.hartmann@example.org",
  "external_person_phone": "+49 511 123456",
  "external_person_address_city": "Hannover",
  "external_person_address_zip": "30163",
  "external_person_address_country": "DE",
  "external_company_name": "Beispiel",
  "external_company_email": "lena.hartmann@example.org"
}

Dismiss a follow-up the AI suggested for this ticket.

POST/api/crm/tickets/{id}/ai_follow_up/dismiss

Path parameters

idrequiredstring

Request body application/json

  • dataobject
    Show fields (1)
    • sourcestring

      Key of the suggestion in ai_follow_ups

Responses

200The ticketCustomerTicket4

Show fields (21)
  • satisfaction_requested_atstring

    When the customer / member was asked to rate the finished ticket; the apps offer the rating once this is set.

  • idinteger

    Primary key of the ticket. Internal ID.

  • ticket_typestring

    Type of the ticket.

  • numberinteger

    Running ticket number.

  • number_stringstring

    Ticket number as displayed to users.

  • companyCRMCompany

    Company the ticket belongs to.

    Show fields (55)
    • idinteger

      Primary key of the company. Internal ID.

    • short_namestring

      Short name of the company.

    • company_namestring

      Legal name of the company.

    • secondary_namestring

      Second name line of the company.

    • direct_dialstring

      Direct dial number of the company.

    • invoice_emailstring

      E-mail address for invoices.

    • send_invoice_emailboolean

      Send invoices by e-mail.

    • send_invoice_letterboolean

      Send invoices by letter.

    • time_report_emailstring

      E-mail address for time reports.

    • payment_goalPaymentGoal

      Payment term of the company.

    • payment_intervalstring

      Interval of the payments.

    • vatidstring

      VAT identification number.

    • taxnumberstring

      Tax number of the company.

    • buyer_reference_idstring

      Leitweg-ID or custom reference ID defined by the customer

    • taxTax

      Tax rate used for the company.

    • infostring

      Information about the company.

    • numberstring

      Customer or supplier number of the company.

    • manual_numberinteger

      Number set manually instead of the automatic number.

    • number_stringstring

      Company number as text, including prefix.

    • is_customerboolean

      The company is a customer.

    • is_supplierboolean

      The company is a supplier.

    • is_otherboolean

      The company is neither customer nor supplier.

    • is_memberboolean

      The company is a member.

    • archivedboolean

      The company is archived.

    • categoryCRMCompanyCategory

      Category of the company.

    • visible_for_customerboolean

      Whether the company is visible to the customer.

    • founding_datestring (date-time)

      Founding date of the company.

    • nace_sectionstring

      NACE section code (letter A-U)

    • nace_codestring

      NACE code (numeric like 01.11, 62.01)

    • search_stringstring

      Text that the entity can be searched by.

    • addressstring

      Address as text.

    • address_streetstring

      Street of the address.

    • address_house_numberstring

      House number of the address.

    • address_street_levelstring

      Street and house number of the address.

    • address_costring

      Care-of line of the address.

    • address_citystring

      City of the address.

    • address_zipstring

      Postal code of the address.

    • address_admin_level1string

      First administrative level of the address, e.g. the federal state.

    • address_countrystring

      Country code of the address.

    • address_full_countrystring

      Full name of the country of the address.

    • address_geo_latstring

      Latitude of the address.

    • address_geo_lngstring

      Longitude of the address.

    • address_external_provider_idstring

      field to store the external provider id of the address. e.g. Google Maps PlaceID like google:ChIJVcKw5r90sEcRhdjNq6NItqE

    • main_phonestring

      Main phone number.

    • main_faxstring

      Main fax number.

    • main_emailstring

      Main e-mail address.

    • websitestring

      Website address.

    • createdstring (date-time)

      Point in time the entity was created.

    • updatedstring (date-time)

      Point in time the entity was last updated.

    • payment_typePaymentType
    • company_employee_countinteger

      Number of employees of the company.

    • company_founding_yearinteger

      Founding year of the company.

    • company_family_ownedboolean

      Whether the company is family-owned.

    • company_sales_volumestring

      Sales volume of the company.

    • company_segmentstring

      Market segment of the company.

  • personCRMPerson10

    Person the ticket belongs to.

    Show fields (81)
    • idinteger

      Primary key of the person. Internal ID.

    • first_namestring

      First name of the person.

    • last_namestring

      Last name of the person.

    • numberinteger

      Member or customer number of the person.

    • manual_numberinteger

      Number set manually instead of the automatic number.

    • number_stringstring

      Member or customer number as text, including prefix.

    • genderstring

      Gender of the person.

    • titlestring

      Academic or other title of the person.

    • positionstring

      Position or role of the person.

    • languagestring

      Preferred language of the person.

    • special_salutationstring

      Special salutation text for letters.

    • form_of_salutationstring

      Form of salutation, for example formal or informal.

    • birthdaystring (date-time)

      Birthday of the person.

    • known_allergiesstring

      Known allergies of the person.

    • confirmed_no_allergiesboolean

      Guardian confirmed that there are no known allergies.

    • allow_photosboolean

      Photos of the person may be taken and published.

    • allow_leaving_aloneboolean

      The person may leave the event alone.

    • authorized_pickupstring

      Persons who are allowed to pick up the person.

    • needs_supportboolean

      The person needs support, for example for inclusion.

    • support_descriptionstring

      Description of the support the person needs.

    • financial_supportboolean

      The person receives financial support.

    • financial_support_numberstring

      Number of the financial support.

    • municipal_supportboolean

      The person receives municipal support.

    • municipal_support_numberstring

      Number of the municipal support.

    • grade_levelinteger

      School grade level of the person.

    • school_classstring

      School class of the person.

    • start_timestring (date-time)

      Start of the membership or activity.

    • start_time_reasonstring

      Reason for the start.

    • end_timestring (date-time)

      End of the membership or activity.

    • end_time_reasonstring

      Reason for the end.

    • confirmed_gtc_timestring (date-time)

      Time the general terms and conditions were confirmed.

    • chatbot_opt_inboolean

      Einwilligung in die Nutzung des KI-Assistenten. Denormalisierter aktueller Stand - das pruefbare Protokoll steht in ChatbotConsent.

    • chatbot_opt_in_atstring (date-time)

      Time the person opted in to the chatbot.

    • chatbot_opt_in_text_versionstring

      Version des Einwilligungstextes, dem zugestimmt wurde. Weicht sie von der aktuellen Version ab, ist das Opt-in abgelaufen.

    • app_usage_statistics_opt_outboolean

      Widerspruch gegen die anonyme Nutzungsstatistik der Mitglieder-App. Die App liest ihn aus den StaticData und schickt dann nichts mehr; die gezaehlten Aufrufe selbst haben keinen Bezug zur Person.

    • crm_person_contact_dataarray<CRMPersonContactData>

      Contact data of the person, for example phone and e-mail.

    • archivedboolean

      Whether the person is archived.

    • subscribed_newsletterboolean

      Whether the person subscribed to the newsletter.

    • subscribed_magazineboolean

      Whether the person subscribed to the magazine.

    • printed_member_cardboolean

      Whether a member card has been printed for the person.

    • has_login_userboolean

      Whether the person has a login user.

    • profile_picture_urlstring

      URL of the profile picture of the person.

    • log_book_staffboolean

      Log book flag: staff.

    • log_book_staff1boolean

      Log book flag: staff, level 1.

    • log_book_staff2boolean

      Log book flag: staff, level 2.

    • log_book_memberboolean

      Log book flag: member.

    • log_book_trainerboolean

      Log book flag: trainer.

    • log_book_trainer1boolean

      Log book flag: trainer, level 1.

    • log_book_trainer2boolean

      Log book flag: trainer, level 2.

    • log_book_head_of_departmentboolean

      Log book flag: head of department.

    • log_book_supervisory_boardboolean

      Log book flag: supervisory board.

    • log_book_board_of_directorsboolean

      Log book flag: board of directors.

    • log_book_honorary_memberboolean

      Log book flag: honorary member.

    • log_book_club_card_oneboolean

      Log book flag: club card.

    • log_book_health_recoveredboolean

      Log book flag: recovered from illness.

    • log_book_health_vaccinatedboolean

      Log book flag: vaccinated.

    • log_book_health_vaccinated_additionstring

      Details of the vaccination.

    • log_book_good_conductboolean

      Log book flag: certificate of good conduct.

    • log_book_first_aidboolean

      Log book flag: first aid training.

    • log_book_measles_vaccinationboolean

      Log book flag: measles vaccination.

    • sync_lanistaboolean

      Whether the person is synchronized with Lanista.

    • categoryCRMPersonCategory

      Person category.

    • nicknamestring

      Nickname of the person.

    • preferred_color_hexstring

      Preferred color of the person as hex value.

    • avatar_tokenstring

      Token of the avatar image.

    • search_stringstring

      Text that the entity can be searched by.

    • addressstring

      Address as text.

    • address_streetstring

      Street of the address.

    • address_house_numberstring

      House number of the address.

    • address_street_levelstring

      Street and house number of the address.

    • address_costring

      Care-of line of the address.

    • address_citystring

      City of the address.

    • address_zipstring

      Postal code of the address.

    • address_admin_level1string

      First administrative level of the address, e.g. the federal state.

    • address_countrystring

      Country code of the address.

    • address_full_countrystring

      Full name of the country of the address.

    • address_geo_latstring

      Latitude of the address.

    • address_geo_lngstring

      Longitude of the address.

    • address_external_provider_idstring

      field to store the external provider id of the address. e.g. Google Maps PlaceID like google:ChIJVcKw5r90sEcRhdjNq6NItqE

    • createdstring (date-time)

      Point in time the entity was created.

    • … 2 more fields
  • jirakeystring

    Key of the linked Jira issue.

  • jiraidstring

    ID of the linked Jira issue.

  • assignedusernamestring

    Name of the assigned user, as text.

  • assigned_userUser

    User the ticket is assigned to.

    Show fields (11)
    • idinteger

      Primary key of the user. Internal ID of the login user.

    • namestring

      Display name of the user. Shown in the UI and in audit entries.

    • usernamestring

      Login name of the user. Must be unique across all users.

    • emailstring

      E-mail address of the user. Used for login notifications, password resets and as a login alias.

    • user_access_groupUserAccessGroup3

      User access group of the user. Defines the rights of the user for all scopes.

    • positioningeneralstring

      Free text describing the position or role of the user.

    • crm_personCRMPerson10

      CRM person linked to this login user. Connects the login account with the person record.

    • profile_picture_urlstring

      URL of the profile picture of the user.

    • archivedboolean

      Marks the user as archived. Archived users are kept for history and are not active.

    • require2faboolean

      Two-factor authentication is required for this user.

    • search_stringstring

      Text that the entity can be searched by.

  • createdbyusernamestring

    Name of the user who created the ticket, as text.

  • created_by_userUser

    User who created the ticket.

    Show fields (11)
    • idinteger

      Primary key of the user. Internal ID of the login user.

    • namestring

      Display name of the user. Shown in the UI and in audit entries.

    • usernamestring

      Login name of the user. Must be unique across all users.

    • emailstring

      E-mail address of the user. Used for login notifications, password resets and as a login alias.

    • user_access_groupUserAccessGroup3

      User access group of the user. Defines the rights of the user for all scopes.

    • positioningeneralstring

      Free text describing the position or role of the user.

    • crm_personCRMPerson10

      CRM person linked to this login user. Connects the login account with the person record.

    • profile_picture_urlstring

      URL of the profile picture of the user.

    • archivedboolean

      Marks the user as archived. Archived users are kept for history and are not active.

    • require2faboolean

      Two-factor authentication is required for this user.

    • search_stringstring

      Text that the entity can be searched by.

  • statusstring

    Status of the ticket as text.

  • statusidstring

    ID of the status of the ticket.

  • issuetypestring

    A type like bug, task, story

  • issuecategorystring

    A category like website, hosting, marketing

  • crm_project_category_areaCRMProjectCategoryArea

    Project category area the ticket belongs to.

    Show fields (4)
    • idinteger

      Primary key of the category area. Internal ID.

    • namestring

      Name of the area.

    • descriptionstring

      Description of the area.

    • deletedboolean

      This property is used to mark an entity as deleted / archived

  • issueprojectstring

    A project like a domain (inwendo.de) or a certain mail campaign

  • crm_projectCRMProject10

    CRM project the ticket belongs to.

    Show fields (19)
    • idinteger

      Primary key of the project. Internal ID.

    • namestring

      Name of the project.

    • closedstring (date-time)

      Time the project was closed.

    • billedstring (date-time)

      Time the project was billed.

    • numberstring

      Number of the project.

    • startstring (date-time)

      Start of the project.

    • endstring (date-time)

      End of the project.

    • descriptionstring

      Description of the project.

    • companyCRMCompany

      Company the project belongs to.

    • internal_main_contactUser

      Internal login user who is the main contact.

    • categoryCRMProjectCategory

      Category of the project.

    • archivedboolean

      The project is archived.

    • visible_for_customerboolean

      The project is visible in the customer app.

    • name_for_customerstring

      Name of the project shown to customers.

    • invoice_emailstring

      E-mail address for invoices of the project.

    • time_report_emailstring

      E-mail address for time reports of the project.

    • search_stringstring

      Text that the entity can be searched by.

    • createdstring (date-time)

      Point in time the entity was created.

    • updatedstring (date-time)

      Point in time the entity was last updated.

  • … 51 more fields
Request
curl --request POST \
  --url https://your-instance.iw-erp.de/api/crm/tickets/42/ai_follow_up/dismiss \
  --header 'content-type: application/json' \
  --header 'x-iw-jwt-token: <TOKEN>' \
  --data '
{
  "data": {
    "source": "comment_12"
  }
}
'
Response 200 application/json
{
  "id": 42,
  "external_person_first_name": "Beispiel",
  "external_person_last_name": "Beispiel",
  "external_person_email": "lena.hartmann@example.org",
  "external_person_phone": "+49 511 123456",
  "external_person_address_city": "Hannover",
  "external_person_address_zip": "30163",
  "external_person_address_country": "DE",
  "external_company_name": "Beispiel",
  "external_company_email": "lena.hartmann@example.org"
}

Summarize the ticket and its history with the AI (customer_panel_ai_ticket_summary_enabled).

POST/api/crm/tickets/{id}/ai_summary

The summary is stored on the ticket (ai_summary, only for the team) and returned with it.

Path parameters

idrequiredstring

Responses

200The ticket with its new summaryCustomerTicket4

Show fields (21)
  • satisfaction_requested_atstring

    When the customer / member was asked to rate the finished ticket; the apps offer the rating once this is set.

  • idinteger

    Primary key of the ticket. Internal ID.

  • ticket_typestring

    Type of the ticket.

  • numberinteger

    Running ticket number.

  • number_stringstring

    Ticket number as displayed to users.

  • companyCRMCompany

    Company the ticket belongs to.

    Show fields (55)
    • idinteger

      Primary key of the company. Internal ID.

    • short_namestring

      Short name of the company.

    • company_namestring

      Legal name of the company.

    • secondary_namestring

      Second name line of the company.

    • direct_dialstring

      Direct dial number of the company.

    • invoice_emailstring

      E-mail address for invoices.

    • send_invoice_emailboolean

      Send invoices by e-mail.

    • send_invoice_letterboolean

      Send invoices by letter.

    • time_report_emailstring

      E-mail address for time reports.

    • payment_goalPaymentGoal

      Payment term of the company.

    • payment_intervalstring

      Interval of the payments.

    • vatidstring

      VAT identification number.

    • taxnumberstring

      Tax number of the company.

    • buyer_reference_idstring

      Leitweg-ID or custom reference ID defined by the customer

    • taxTax

      Tax rate used for the company.

    • infostring

      Information about the company.

    • numberstring

      Customer or supplier number of the company.

    • manual_numberinteger

      Number set manually instead of the automatic number.

    • number_stringstring

      Company number as text, including prefix.

    • is_customerboolean

      The company is a customer.

    • is_supplierboolean

      The company is a supplier.

    • is_otherboolean

      The company is neither customer nor supplier.

    • is_memberboolean

      The company is a member.

    • archivedboolean

      The company is archived.

    • categoryCRMCompanyCategory

      Category of the company.

    • visible_for_customerboolean

      Whether the company is visible to the customer.

    • founding_datestring (date-time)

      Founding date of the company.

    • nace_sectionstring

      NACE section code (letter A-U)

    • nace_codestring

      NACE code (numeric like 01.11, 62.01)

    • search_stringstring

      Text that the entity can be searched by.

    • addressstring

      Address as text.

    • address_streetstring

      Street of the address.

    • address_house_numberstring

      House number of the address.

    • address_street_levelstring

      Street and house number of the address.

    • address_costring

      Care-of line of the address.

    • address_citystring

      City of the address.

    • address_zipstring

      Postal code of the address.

    • address_admin_level1string

      First administrative level of the address, e.g. the federal state.

    • address_countrystring

      Country code of the address.

    • address_full_countrystring

      Full name of the country of the address.

    • address_geo_latstring

      Latitude of the address.

    • address_geo_lngstring

      Longitude of the address.

    • address_external_provider_idstring

      field to store the external provider id of the address. e.g. Google Maps PlaceID like google:ChIJVcKw5r90sEcRhdjNq6NItqE

    • main_phonestring

      Main phone number.

    • main_faxstring

      Main fax number.

    • main_emailstring

      Main e-mail address.

    • websitestring

      Website address.

    • createdstring (date-time)

      Point in time the entity was created.

    • updatedstring (date-time)

      Point in time the entity was last updated.

    • payment_typePaymentType
    • company_employee_countinteger

      Number of employees of the company.

    • company_founding_yearinteger

      Founding year of the company.

    • company_family_ownedboolean

      Whether the company is family-owned.

    • company_sales_volumestring

      Sales volume of the company.

    • company_segmentstring

      Market segment of the company.

  • personCRMPerson10

    Person the ticket belongs to.

    Show fields (81)
    • idinteger

      Primary key of the person. Internal ID.

    • first_namestring

      First name of the person.

    • last_namestring

      Last name of the person.

    • numberinteger

      Member or customer number of the person.

    • manual_numberinteger

      Number set manually instead of the automatic number.

    • number_stringstring

      Member or customer number as text, including prefix.

    • genderstring

      Gender of the person.

    • titlestring

      Academic or other title of the person.

    • positionstring

      Position or role of the person.

    • languagestring

      Preferred language of the person.

    • special_salutationstring

      Special salutation text for letters.

    • form_of_salutationstring

      Form of salutation, for example formal or informal.

    • birthdaystring (date-time)

      Birthday of the person.

    • known_allergiesstring

      Known allergies of the person.

    • confirmed_no_allergiesboolean

      Guardian confirmed that there are no known allergies.

    • allow_photosboolean

      Photos of the person may be taken and published.

    • allow_leaving_aloneboolean

      The person may leave the event alone.

    • authorized_pickupstring

      Persons who are allowed to pick up the person.

    • needs_supportboolean

      The person needs support, for example for inclusion.

    • support_descriptionstring

      Description of the support the person needs.

    • financial_supportboolean

      The person receives financial support.

    • financial_support_numberstring

      Number of the financial support.

    • municipal_supportboolean

      The person receives municipal support.

    • municipal_support_numberstring

      Number of the municipal support.

    • grade_levelinteger

      School grade level of the person.

    • school_classstring

      School class of the person.

    • start_timestring (date-time)

      Start of the membership or activity.

    • start_time_reasonstring

      Reason for the start.

    • end_timestring (date-time)

      End of the membership or activity.

    • end_time_reasonstring

      Reason for the end.

    • confirmed_gtc_timestring (date-time)

      Time the general terms and conditions were confirmed.

    • chatbot_opt_inboolean

      Einwilligung in die Nutzung des KI-Assistenten. Denormalisierter aktueller Stand - das pruefbare Protokoll steht in ChatbotConsent.

    • chatbot_opt_in_atstring (date-time)

      Time the person opted in to the chatbot.

    • chatbot_opt_in_text_versionstring

      Version des Einwilligungstextes, dem zugestimmt wurde. Weicht sie von der aktuellen Version ab, ist das Opt-in abgelaufen.

    • app_usage_statistics_opt_outboolean

      Widerspruch gegen die anonyme Nutzungsstatistik der Mitglieder-App. Die App liest ihn aus den StaticData und schickt dann nichts mehr; die gezaehlten Aufrufe selbst haben keinen Bezug zur Person.

    • crm_person_contact_dataarray<CRMPersonContactData>

      Contact data of the person, for example phone and e-mail.

    • archivedboolean

      Whether the person is archived.

    • subscribed_newsletterboolean

      Whether the person subscribed to the newsletter.

    • subscribed_magazineboolean

      Whether the person subscribed to the magazine.

    • printed_member_cardboolean

      Whether a member card has been printed for the person.

    • has_login_userboolean

      Whether the person has a login user.

    • profile_picture_urlstring

      URL of the profile picture of the person.

    • log_book_staffboolean

      Log book flag: staff.

    • log_book_staff1boolean

      Log book flag: staff, level 1.

    • log_book_staff2boolean

      Log book flag: staff, level 2.

    • log_book_memberboolean

      Log book flag: member.

    • log_book_trainerboolean

      Log book flag: trainer.

    • log_book_trainer1boolean

      Log book flag: trainer, level 1.

    • log_book_trainer2boolean

      Log book flag: trainer, level 2.

    • log_book_head_of_departmentboolean

      Log book flag: head of department.

    • log_book_supervisory_boardboolean

      Log book flag: supervisory board.

    • log_book_board_of_directorsboolean

      Log book flag: board of directors.

    • log_book_honorary_memberboolean

      Log book flag: honorary member.

    • log_book_club_card_oneboolean

      Log book flag: club card.

    • log_book_health_recoveredboolean

      Log book flag: recovered from illness.

    • log_book_health_vaccinatedboolean

      Log book flag: vaccinated.

    • log_book_health_vaccinated_additionstring

      Details of the vaccination.

    • log_book_good_conductboolean

      Log book flag: certificate of good conduct.

    • log_book_first_aidboolean

      Log book flag: first aid training.

    • log_book_measles_vaccinationboolean

      Log book flag: measles vaccination.

    • sync_lanistaboolean

      Whether the person is synchronized with Lanista.

    • categoryCRMPersonCategory

      Person category.

    • nicknamestring

      Nickname of the person.

    • preferred_color_hexstring

      Preferred color of the person as hex value.

    • avatar_tokenstring

      Token of the avatar image.

    • search_stringstring

      Text that the entity can be searched by.

    • addressstring

      Address as text.

    • address_streetstring

      Street of the address.

    • address_house_numberstring

      House number of the address.

    • address_street_levelstring

      Street and house number of the address.

    • address_costring

      Care-of line of the address.

    • address_citystring

      City of the address.

    • address_zipstring

      Postal code of the address.

    • address_admin_level1string

      First administrative level of the address, e.g. the federal state.

    • address_countrystring

      Country code of the address.

    • address_full_countrystring

      Full name of the country of the address.

    • address_geo_latstring

      Latitude of the address.

    • address_geo_lngstring

      Longitude of the address.

    • address_external_provider_idstring

      field to store the external provider id of the address. e.g. Google Maps PlaceID like google:ChIJVcKw5r90sEcRhdjNq6NItqE

    • createdstring (date-time)

      Point in time the entity was created.

    • … 2 more fields
  • jirakeystring

    Key of the linked Jira issue.

  • jiraidstring

    ID of the linked Jira issue.

  • assignedusernamestring

    Name of the assigned user, as text.

  • assigned_userUser

    User the ticket is assigned to.

    Show fields (11)
    • idinteger

      Primary key of the user. Internal ID of the login user.

    • namestring

      Display name of the user. Shown in the UI and in audit entries.

    • usernamestring

      Login name of the user. Must be unique across all users.

    • emailstring

      E-mail address of the user. Used for login notifications, password resets and as a login alias.

    • user_access_groupUserAccessGroup3

      User access group of the user. Defines the rights of the user for all scopes.

    • positioningeneralstring

      Free text describing the position or role of the user.

    • crm_personCRMPerson10

      CRM person linked to this login user. Connects the login account with the person record.

    • profile_picture_urlstring

      URL of the profile picture of the user.

    • archivedboolean

      Marks the user as archived. Archived users are kept for history and are not active.

    • require2faboolean

      Two-factor authentication is required for this user.

    • search_stringstring

      Text that the entity can be searched by.

  • createdbyusernamestring

    Name of the user who created the ticket, as text.

  • created_by_userUser

    User who created the ticket.

    Show fields (11)
    • idinteger

      Primary key of the user. Internal ID of the login user.

    • namestring

      Display name of the user. Shown in the UI and in audit entries.

    • usernamestring

      Login name of the user. Must be unique across all users.

    • emailstring

      E-mail address of the user. Used for login notifications, password resets and as a login alias.

    • user_access_groupUserAccessGroup3

      User access group of the user. Defines the rights of the user for all scopes.

    • positioningeneralstring

      Free text describing the position or role of the user.

    • crm_personCRMPerson10

      CRM person linked to this login user. Connects the login account with the person record.

    • profile_picture_urlstring

      URL of the profile picture of the user.

    • archivedboolean

      Marks the user as archived. Archived users are kept for history and are not active.

    • require2faboolean

      Two-factor authentication is required for this user.

    • search_stringstring

      Text that the entity can be searched by.

  • statusstring

    Status of the ticket as text.

  • statusidstring

    ID of the status of the ticket.

  • issuetypestring

    A type like bug, task, story

  • issuecategorystring

    A category like website, hosting, marketing

  • crm_project_category_areaCRMProjectCategoryArea

    Project category area the ticket belongs to.

    Show fields (4)
    • idinteger

      Primary key of the category area. Internal ID.

    • namestring

      Name of the area.

    • descriptionstring

      Description of the area.

    • deletedboolean

      This property is used to mark an entity as deleted / archived

  • issueprojectstring

    A project like a domain (inwendo.de) or a certain mail campaign

  • crm_projectCRMProject10

    CRM project the ticket belongs to.

    Show fields (19)
    • idinteger

      Primary key of the project. Internal ID.

    • namestring

      Name of the project.

    • closedstring (date-time)

      Time the project was closed.

    • billedstring (date-time)

      Time the project was billed.

    • numberstring

      Number of the project.

    • startstring (date-time)

      Start of the project.

    • endstring (date-time)

      End of the project.

    • descriptionstring

      Description of the project.

    • companyCRMCompany

      Company the project belongs to.

    • internal_main_contactUser

      Internal login user who is the main contact.

    • categoryCRMProjectCategory

      Category of the project.

    • archivedboolean

      The project is archived.

    • visible_for_customerboolean

      The project is visible in the customer app.

    • name_for_customerstring

      Name of the project shown to customers.

    • invoice_emailstring

      E-mail address for invoices of the project.

    • time_report_emailstring

      E-mail address for time reports of the project.

    • search_stringstring

      Text that the entity can be searched by.

    • createdstring (date-time)

      Point in time the entity was created.

    • updatedstring (date-time)

      Point in time the entity was last updated.

  • … 51 more fields
Request
curl --request POST \
  --url https://your-instance.iw-erp.de/api/crm/tickets/42/ai_summary \
  --header 'x-iw-jwt-token: <TOKEN>'
Response 200 application/json
{
  "id": 42,
  "external_person_first_name": "Beispiel",
  "external_person_last_name": "Beispiel",
  "external_person_email": "lena.hartmann@example.org",
  "external_person_phone": "+49 511 123456",
  "external_person_address_city": "Hannover",
  "external_person_address_zip": "30163",
  "external_person_address_country": "DE",
  "external_company_name": "Beispiel",
  "external_company_email": "lena.hartmann@example.org"
}

This method will set a new Status for the Ticket

POST/api/crm/tickets/{id}/statuses

Path parameters

idrequiredstring

Responses

200Set a new Status for a TicketCustomerTicket3

Show fields (21)
  • satisfaction_requested_atstring

    When the customer / member was asked to rate the finished ticket; the apps offer the rating once this is set.

  • idinteger

    Primary key of the ticket. Internal ID.

  • ticket_typestring

    Type of the ticket.

  • numberinteger

    Running ticket number.

  • number_stringstring

    Ticket number as displayed to users.

  • companyCRMCompany19

    Company the ticket belongs to.

    Show fields (56)
    • idinteger

      Primary key of the company. Internal ID.

    • short_namestring

      Short name of the company.

    • company_namestring

      Legal name of the company.

    • secondary_namestring

      Second name line of the company.

    • direct_dialstring

      Direct dial number of the company.

    • invoice_emailstring

      E-mail address for invoices.

    • send_invoice_emailboolean

      Send invoices by e-mail.

    • send_invoice_letterboolean

      Send invoices by letter.

    • time_report_emailstring

      E-mail address for time reports.

    • payment_goalPaymentGoal

      Payment term of the company.

    • payment_intervalstring

      Interval of the payments.

    • vatidstring

      VAT identification number.

    • taxnumberstring

      Tax number of the company.

    • buyer_reference_idstring

      Leitweg-ID or custom reference ID defined by the customer

    • taxTax

      Tax rate used for the company.

    • infostring

      Information about the company.

    • numberstring

      Customer or supplier number of the company.

    • manual_numberinteger

      Number set manually instead of the automatic number.

    • number_stringstring

      Company number as text, including prefix.

    • is_customerboolean

      The company is a customer.

    • is_supplierboolean

      The company is a supplier.

    • is_otherboolean

      The company is neither customer nor supplier.

    • is_memberboolean

      The company is a member.

    • archivedboolean

      The company is archived.

    • categoryCRMCompanyCategory

      Category of the company.

    • visible_for_customerboolean

      Whether the company is visible to the customer.

    • founding_datestring (date-time)

      Founding date of the company.

    • nace_sectionstring

      NACE section code (letter A-U)

    • nace_codestring

      NACE code (numeric like 01.11, 62.01)

    • search_stringstring

      Text that the entity can be searched by.

    • addressstring

      Address as text.

    • address_streetstring

      Street of the address.

    • address_house_numberstring

      House number of the address.

    • address_street_levelstring

      Street and house number of the address.

    • address_costring

      Care-of line of the address.

    • address_citystring

      City of the address.

    • address_zipstring

      Postal code of the address.

    • address_admin_level1string

      First administrative level of the address, e.g. the federal state.

    • address_countrystring

      Country code of the address.

    • address_full_countrystring

      Full name of the country of the address.

    • address_geo_latstring

      Latitude of the address.

    • address_geo_lngstring

      Longitude of the address.

    • address_external_provider_idstring

      field to store the external provider id of the address. e.g. Google Maps PlaceID like google:ChIJVcKw5r90sEcRhdjNq6NItqE

    • main_phonestring

      Main phone number.

    • main_faxstring

      Main fax number.

    • main_emailstring

      Main e-mail address.

    • websitestring

      Website address.

    • createdstring (date-time)

      Point in time the entity was created.

    • updatedstring (date-time)

      Point in time the entity was last updated.

    • atagsarray<AccessTag>
    • payment_typePaymentType
    • company_employee_countinteger

      Number of employees of the company.

    • company_founding_yearinteger

      Founding year of the company.

    • company_family_ownedboolean

      Whether the company is family-owned.

    • company_sales_volumestring

      Sales volume of the company.

    • company_segmentstring

      Market segment of the company.

  • personCRMPerson10

    Person the ticket belongs to.

    Show fields (81)
    • idinteger

      Primary key of the person. Internal ID.

    • first_namestring

      First name of the person.

    • last_namestring

      Last name of the person.

    • numberinteger

      Member or customer number of the person.

    • manual_numberinteger

      Number set manually instead of the automatic number.

    • number_stringstring

      Member or customer number as text, including prefix.

    • genderstring

      Gender of the person.

    • titlestring

      Academic or other title of the person.

    • positionstring

      Position or role of the person.

    • languagestring

      Preferred language of the person.

    • special_salutationstring

      Special salutation text for letters.

    • form_of_salutationstring

      Form of salutation, for example formal or informal.

    • birthdaystring (date-time)

      Birthday of the person.

    • known_allergiesstring

      Known allergies of the person.

    • confirmed_no_allergiesboolean

      Guardian confirmed that there are no known allergies.

    • allow_photosboolean

      Photos of the person may be taken and published.

    • allow_leaving_aloneboolean

      The person may leave the event alone.

    • authorized_pickupstring

      Persons who are allowed to pick up the person.

    • needs_supportboolean

      The person needs support, for example for inclusion.

    • support_descriptionstring

      Description of the support the person needs.

    • financial_supportboolean

      The person receives financial support.

    • financial_support_numberstring

      Number of the financial support.

    • municipal_supportboolean

      The person receives municipal support.

    • municipal_support_numberstring

      Number of the municipal support.

    • grade_levelinteger

      School grade level of the person.

    • school_classstring

      School class of the person.

    • start_timestring (date-time)

      Start of the membership or activity.

    • start_time_reasonstring

      Reason for the start.

    • end_timestring (date-time)

      End of the membership or activity.

    • end_time_reasonstring

      Reason for the end.

    • confirmed_gtc_timestring (date-time)

      Time the general terms and conditions were confirmed.

    • chatbot_opt_inboolean

      Einwilligung in die Nutzung des KI-Assistenten. Denormalisierter aktueller Stand - das pruefbare Protokoll steht in ChatbotConsent.

    • chatbot_opt_in_atstring (date-time)

      Time the person opted in to the chatbot.

    • chatbot_opt_in_text_versionstring

      Version des Einwilligungstextes, dem zugestimmt wurde. Weicht sie von der aktuellen Version ab, ist das Opt-in abgelaufen.

    • app_usage_statistics_opt_outboolean

      Widerspruch gegen die anonyme Nutzungsstatistik der Mitglieder-App. Die App liest ihn aus den StaticData und schickt dann nichts mehr; die gezaehlten Aufrufe selbst haben keinen Bezug zur Person.

    • crm_person_contact_dataarray<CRMPersonContactData>

      Contact data of the person, for example phone and e-mail.

    • archivedboolean

      Whether the person is archived.

    • subscribed_newsletterboolean

      Whether the person subscribed to the newsletter.

    • subscribed_magazineboolean

      Whether the person subscribed to the magazine.

    • printed_member_cardboolean

      Whether a member card has been printed for the person.

    • has_login_userboolean

      Whether the person has a login user.

    • profile_picture_urlstring

      URL of the profile picture of the person.

    • log_book_staffboolean

      Log book flag: staff.

    • log_book_staff1boolean

      Log book flag: staff, level 1.

    • log_book_staff2boolean

      Log book flag: staff, level 2.

    • log_book_memberboolean

      Log book flag: member.

    • log_book_trainerboolean

      Log book flag: trainer.

    • log_book_trainer1boolean

      Log book flag: trainer, level 1.

    • log_book_trainer2boolean

      Log book flag: trainer, level 2.

    • log_book_head_of_departmentboolean

      Log book flag: head of department.

    • log_book_supervisory_boardboolean

      Log book flag: supervisory board.

    • log_book_board_of_directorsboolean

      Log book flag: board of directors.

    • log_book_honorary_memberboolean

      Log book flag: honorary member.

    • log_book_club_card_oneboolean

      Log book flag: club card.

    • log_book_health_recoveredboolean

      Log book flag: recovered from illness.

    • log_book_health_vaccinatedboolean

      Log book flag: vaccinated.

    • log_book_health_vaccinated_additionstring

      Details of the vaccination.

    • log_book_good_conductboolean

      Log book flag: certificate of good conduct.

    • log_book_first_aidboolean

      Log book flag: first aid training.

    • log_book_measles_vaccinationboolean

      Log book flag: measles vaccination.

    • sync_lanistaboolean

      Whether the person is synchronized with Lanista.

    • categoryCRMPersonCategory

      Person category.

    • nicknamestring

      Nickname of the person.

    • preferred_color_hexstring

      Preferred color of the person as hex value.

    • avatar_tokenstring

      Token of the avatar image.

    • search_stringstring

      Text that the entity can be searched by.

    • addressstring

      Address as text.

    • address_streetstring

      Street of the address.

    • address_house_numberstring

      House number of the address.

    • address_street_levelstring

      Street and house number of the address.

    • address_costring

      Care-of line of the address.

    • address_citystring

      City of the address.

    • address_zipstring

      Postal code of the address.

    • address_admin_level1string

      First administrative level of the address, e.g. the federal state.

    • address_countrystring

      Country code of the address.

    • address_full_countrystring

      Full name of the country of the address.

    • address_geo_latstring

      Latitude of the address.

    • address_geo_lngstring

      Longitude of the address.

    • address_external_provider_idstring

      field to store the external provider id of the address. e.g. Google Maps PlaceID like google:ChIJVcKw5r90sEcRhdjNq6NItqE

    • createdstring (date-time)

      Point in time the entity was created.

    • … 2 more fields
  • jirakeystring

    Key of the linked Jira issue.

  • jiraidstring

    ID of the linked Jira issue.

  • assignedusernamestring

    Name of the assigned user, as text.

  • assigned_userUser

    User the ticket is assigned to.

    Show fields (11)
    • idinteger

      Primary key of the user. Internal ID of the login user.

    • namestring

      Display name of the user. Shown in the UI and in audit entries.

    • usernamestring

      Login name of the user. Must be unique across all users.

    • emailstring

      E-mail address of the user. Used for login notifications, password resets and as a login alias.

    • user_access_groupUserAccessGroup3

      User access group of the user. Defines the rights of the user for all scopes.

    • positioningeneralstring

      Free text describing the position or role of the user.

    • crm_personCRMPerson10

      CRM person linked to this login user. Connects the login account with the person record.

    • profile_picture_urlstring

      URL of the profile picture of the user.

    • archivedboolean

      Marks the user as archived. Archived users are kept for history and are not active.

    • require2faboolean

      Two-factor authentication is required for this user.

    • search_stringstring

      Text that the entity can be searched by.

  • createdbyusernamestring

    Name of the user who created the ticket, as text.

  • created_by_userUser

    User who created the ticket.

    Show fields (11)
    • idinteger

      Primary key of the user. Internal ID of the login user.

    • namestring

      Display name of the user. Shown in the UI and in audit entries.

    • usernamestring

      Login name of the user. Must be unique across all users.

    • emailstring

      E-mail address of the user. Used for login notifications, password resets and as a login alias.

    • user_access_groupUserAccessGroup3

      User access group of the user. Defines the rights of the user for all scopes.

    • positioningeneralstring

      Free text describing the position or role of the user.

    • crm_personCRMPerson10

      CRM person linked to this login user. Connects the login account with the person record.

    • profile_picture_urlstring

      URL of the profile picture of the user.

    • archivedboolean

      Marks the user as archived. Archived users are kept for history and are not active.

    • require2faboolean

      Two-factor authentication is required for this user.

    • search_stringstring

      Text that the entity can be searched by.

  • statusstring

    Status of the ticket as text.

  • statusidstring

    ID of the status of the ticket.

  • issuetypestring

    A type like bug, task, story

  • issuecategorystring

    A category like website, hosting, marketing

  • crm_project_category_areaCRMProjectCategoryArea

    Project category area the ticket belongs to.

    Show fields (4)
    • idinteger

      Primary key of the category area. Internal ID.

    • namestring

      Name of the area.

    • descriptionstring

      Description of the area.

    • deletedboolean

      This property is used to mark an entity as deleted / archived

  • issueprojectstring

    A project like a domain (inwendo.de) or a certain mail campaign

  • crm_projectCRMProject9

    CRM project the ticket belongs to.

    Show fields (19)
    • idinteger

      Primary key of the project. Internal ID.

    • namestring

      Name of the project.

    • closedstring (date-time)

      Time the project was closed.

    • billedstring (date-time)

      Time the project was billed.

    • numberstring

      Number of the project.

    • startstring (date-time)

      Start of the project.

    • endstring (date-time)

      End of the project.

    • descriptionstring

      Description of the project.

    • companyCRMCompany19

      Company the project belongs to.

    • internal_main_contactUser

      Internal login user who is the main contact.

    • categoryCRMProjectCategory

      Category of the project.

    • archivedboolean

      The project is archived.

    • visible_for_customerboolean

      The project is visible in the customer app.

    • name_for_customerstring

      Name of the project shown to customers.

    • invoice_emailstring

      E-mail address for invoices of the project.

    • time_report_emailstring

      E-mail address for time reports of the project.

    • search_stringstring

      Text that the entity can be searched by.

    • createdstring (date-time)

      Point in time the entity was created.

    • … 1 more fields
  • … 51 more fields
Request
curl --request POST \
  --url https://your-instance.iw-erp.de/api/crm/tickets/42/statuses \
  --header 'x-iw-jwt-token: <TOKEN>'
Response 200 application/json
{
  "id": 42,
  "external_person_first_name": "Beispiel",
  "external_person_last_name": "Beispiel",
  "external_person_email": "lena.hartmann@example.org",
  "external_person_phone": "+49 511 123456",
  "external_person_address_city": "Hannover",
  "external_person_address_zip": "30163",
  "external_person_address_country": "DE",
  "external_company_name": "Beispiel",
  "external_company_email": "lena.hartmann@example.org"
}

Add a Attachment to a Ticket

POST/api/crm/tickets/{id}/adds/attachments

Path parameters

idrequiredstring

Responses

200Add an Attachment to a TicketCustomerTicket3

Show fields (21)
  • satisfaction_requested_atstring

    When the customer / member was asked to rate the finished ticket; the apps offer the rating once this is set.

  • idinteger

    Primary key of the ticket. Internal ID.

  • ticket_typestring

    Type of the ticket.

  • numberinteger

    Running ticket number.

  • number_stringstring

    Ticket number as displayed to users.

  • companyCRMCompany19

    Company the ticket belongs to.

    Show fields (56)
    • idinteger

      Primary key of the company. Internal ID.

    • short_namestring

      Short name of the company.

    • company_namestring

      Legal name of the company.

    • secondary_namestring

      Second name line of the company.

    • direct_dialstring

      Direct dial number of the company.

    • invoice_emailstring

      E-mail address for invoices.

    • send_invoice_emailboolean

      Send invoices by e-mail.

    • send_invoice_letterboolean

      Send invoices by letter.

    • time_report_emailstring

      E-mail address for time reports.

    • payment_goalPaymentGoal

      Payment term of the company.

    • payment_intervalstring

      Interval of the payments.

    • vatidstring

      VAT identification number.

    • taxnumberstring

      Tax number of the company.

    • buyer_reference_idstring

      Leitweg-ID or custom reference ID defined by the customer

    • taxTax

      Tax rate used for the company.

    • infostring

      Information about the company.

    • numberstring

      Customer or supplier number of the company.

    • manual_numberinteger

      Number set manually instead of the automatic number.

    • number_stringstring

      Company number as text, including prefix.

    • is_customerboolean

      The company is a customer.

    • is_supplierboolean

      The company is a supplier.

    • is_otherboolean

      The company is neither customer nor supplier.

    • is_memberboolean

      The company is a member.

    • archivedboolean

      The company is archived.

    • categoryCRMCompanyCategory

      Category of the company.

    • visible_for_customerboolean

      Whether the company is visible to the customer.

    • founding_datestring (date-time)

      Founding date of the company.

    • nace_sectionstring

      NACE section code (letter A-U)

    • nace_codestring

      NACE code (numeric like 01.11, 62.01)

    • search_stringstring

      Text that the entity can be searched by.

    • addressstring

      Address as text.

    • address_streetstring

      Street of the address.

    • address_house_numberstring

      House number of the address.

    • address_street_levelstring

      Street and house number of the address.

    • address_costring

      Care-of line of the address.

    • address_citystring

      City of the address.

    • address_zipstring

      Postal code of the address.

    • address_admin_level1string

      First administrative level of the address, e.g. the federal state.

    • address_countrystring

      Country code of the address.

    • address_full_countrystring

      Full name of the country of the address.

    • address_geo_latstring

      Latitude of the address.

    • address_geo_lngstring

      Longitude of the address.

    • address_external_provider_idstring

      field to store the external provider id of the address. e.g. Google Maps PlaceID like google:ChIJVcKw5r90sEcRhdjNq6NItqE

    • main_phonestring

      Main phone number.

    • main_faxstring

      Main fax number.

    • main_emailstring

      Main e-mail address.

    • websitestring

      Website address.

    • createdstring (date-time)

      Point in time the entity was created.

    • updatedstring (date-time)

      Point in time the entity was last updated.

    • atagsarray<AccessTag>
    • payment_typePaymentType
    • company_employee_countinteger

      Number of employees of the company.

    • company_founding_yearinteger

      Founding year of the company.

    • company_family_ownedboolean

      Whether the company is family-owned.

    • company_sales_volumestring

      Sales volume of the company.

    • company_segmentstring

      Market segment of the company.

  • personCRMPerson10

    Person the ticket belongs to.

    Show fields (81)
    • idinteger

      Primary key of the person. Internal ID.

    • first_namestring

      First name of the person.

    • last_namestring

      Last name of the person.

    • numberinteger

      Member or customer number of the person.

    • manual_numberinteger

      Number set manually instead of the automatic number.

    • number_stringstring

      Member or customer number as text, including prefix.

    • genderstring

      Gender of the person.

    • titlestring

      Academic or other title of the person.

    • positionstring

      Position or role of the person.

    • languagestring

      Preferred language of the person.

    • special_salutationstring

      Special salutation text for letters.

    • form_of_salutationstring

      Form of salutation, for example formal or informal.

    • birthdaystring (date-time)

      Birthday of the person.

    • known_allergiesstring

      Known allergies of the person.

    • confirmed_no_allergiesboolean

      Guardian confirmed that there are no known allergies.

    • allow_photosboolean

      Photos of the person may be taken and published.

    • allow_leaving_aloneboolean

      The person may leave the event alone.

    • authorized_pickupstring

      Persons who are allowed to pick up the person.

    • needs_supportboolean

      The person needs support, for example for inclusion.

    • support_descriptionstring

      Description of the support the person needs.

    • financial_supportboolean

      The person receives financial support.

    • financial_support_numberstring

      Number of the financial support.

    • municipal_supportboolean

      The person receives municipal support.

    • municipal_support_numberstring

      Number of the municipal support.

    • grade_levelinteger

      School grade level of the person.

    • school_classstring

      School class of the person.

    • start_timestring (date-time)

      Start of the membership or activity.

    • start_time_reasonstring

      Reason for the start.

    • end_timestring (date-time)

      End of the membership or activity.

    • end_time_reasonstring

      Reason for the end.

    • confirmed_gtc_timestring (date-time)

      Time the general terms and conditions were confirmed.

    • chatbot_opt_inboolean

      Einwilligung in die Nutzung des KI-Assistenten. Denormalisierter aktueller Stand - das pruefbare Protokoll steht in ChatbotConsent.

    • chatbot_opt_in_atstring (date-time)

      Time the person opted in to the chatbot.

    • chatbot_opt_in_text_versionstring

      Version des Einwilligungstextes, dem zugestimmt wurde. Weicht sie von der aktuellen Version ab, ist das Opt-in abgelaufen.

    • app_usage_statistics_opt_outboolean

      Widerspruch gegen die anonyme Nutzungsstatistik der Mitglieder-App. Die App liest ihn aus den StaticData und schickt dann nichts mehr; die gezaehlten Aufrufe selbst haben keinen Bezug zur Person.

    • crm_person_contact_dataarray<CRMPersonContactData>

      Contact data of the person, for example phone and e-mail.

    • archivedboolean

      Whether the person is archived.

    • subscribed_newsletterboolean

      Whether the person subscribed to the newsletter.

    • subscribed_magazineboolean

      Whether the person subscribed to the magazine.

    • printed_member_cardboolean

      Whether a member card has been printed for the person.

    • has_login_userboolean

      Whether the person has a login user.

    • profile_picture_urlstring

      URL of the profile picture of the person.

    • log_book_staffboolean

      Log book flag: staff.

    • log_book_staff1boolean

      Log book flag: staff, level 1.

    • log_book_staff2boolean

      Log book flag: staff, level 2.

    • log_book_memberboolean

      Log book flag: member.

    • log_book_trainerboolean

      Log book flag: trainer.

    • log_book_trainer1boolean

      Log book flag: trainer, level 1.

    • log_book_trainer2boolean

      Log book flag: trainer, level 2.

    • log_book_head_of_departmentboolean

      Log book flag: head of department.

    • log_book_supervisory_boardboolean

      Log book flag: supervisory board.

    • log_book_board_of_directorsboolean

      Log book flag: board of directors.

    • log_book_honorary_memberboolean

      Log book flag: honorary member.

    • log_book_club_card_oneboolean

      Log book flag: club card.

    • log_book_health_recoveredboolean

      Log book flag: recovered from illness.

    • log_book_health_vaccinatedboolean

      Log book flag: vaccinated.

    • log_book_health_vaccinated_additionstring

      Details of the vaccination.

    • log_book_good_conductboolean

      Log book flag: certificate of good conduct.

    • log_book_first_aidboolean

      Log book flag: first aid training.

    • log_book_measles_vaccinationboolean

      Log book flag: measles vaccination.

    • sync_lanistaboolean

      Whether the person is synchronized with Lanista.

    • categoryCRMPersonCategory

      Person category.

    • nicknamestring

      Nickname of the person.

    • preferred_color_hexstring

      Preferred color of the person as hex value.

    • avatar_tokenstring

      Token of the avatar image.

    • search_stringstring

      Text that the entity can be searched by.

    • addressstring

      Address as text.

    • address_streetstring

      Street of the address.

    • address_house_numberstring

      House number of the address.

    • address_street_levelstring

      Street and house number of the address.

    • address_costring

      Care-of line of the address.

    • address_citystring

      City of the address.

    • address_zipstring

      Postal code of the address.

    • address_admin_level1string

      First administrative level of the address, e.g. the federal state.

    • address_countrystring

      Country code of the address.

    • address_full_countrystring

      Full name of the country of the address.

    • address_geo_latstring

      Latitude of the address.

    • address_geo_lngstring

      Longitude of the address.

    • address_external_provider_idstring

      field to store the external provider id of the address. e.g. Google Maps PlaceID like google:ChIJVcKw5r90sEcRhdjNq6NItqE

    • createdstring (date-time)

      Point in time the entity was created.

    • … 2 more fields
  • jirakeystring

    Key of the linked Jira issue.

  • jiraidstring

    ID of the linked Jira issue.

  • assignedusernamestring

    Name of the assigned user, as text.

  • assigned_userUser

    User the ticket is assigned to.

    Show fields (11)
    • idinteger

      Primary key of the user. Internal ID of the login user.

    • namestring

      Display name of the user. Shown in the UI and in audit entries.

    • usernamestring

      Login name of the user. Must be unique across all users.

    • emailstring

      E-mail address of the user. Used for login notifications, password resets and as a login alias.

    • user_access_groupUserAccessGroup3

      User access group of the user. Defines the rights of the user for all scopes.

    • positioningeneralstring

      Free text describing the position or role of the user.

    • crm_personCRMPerson10

      CRM person linked to this login user. Connects the login account with the person record.

    • profile_picture_urlstring

      URL of the profile picture of the user.

    • archivedboolean

      Marks the user as archived. Archived users are kept for history and are not active.

    • require2faboolean

      Two-factor authentication is required for this user.

    • search_stringstring

      Text that the entity can be searched by.

  • createdbyusernamestring

    Name of the user who created the ticket, as text.

  • created_by_userUser

    User who created the ticket.

    Show fields (11)
    • idinteger

      Primary key of the user. Internal ID of the login user.

    • namestring

      Display name of the user. Shown in the UI and in audit entries.

    • usernamestring

      Login name of the user. Must be unique across all users.

    • emailstring

      E-mail address of the user. Used for login notifications, password resets and as a login alias.

    • user_access_groupUserAccessGroup3

      User access group of the user. Defines the rights of the user for all scopes.

    • positioningeneralstring

      Free text describing the position or role of the user.

    • crm_personCRMPerson10

      CRM person linked to this login user. Connects the login account with the person record.

    • profile_picture_urlstring

      URL of the profile picture of the user.

    • archivedboolean

      Marks the user as archived. Archived users are kept for history and are not active.

    • require2faboolean

      Two-factor authentication is required for this user.

    • search_stringstring

      Text that the entity can be searched by.

  • statusstring

    Status of the ticket as text.

  • statusidstring

    ID of the status of the ticket.

  • issuetypestring

    A type like bug, task, story

  • issuecategorystring

    A category like website, hosting, marketing

  • crm_project_category_areaCRMProjectCategoryArea

    Project category area the ticket belongs to.

    Show fields (4)
    • idinteger

      Primary key of the category area. Internal ID.

    • namestring

      Name of the area.

    • descriptionstring

      Description of the area.

    • deletedboolean

      This property is used to mark an entity as deleted / archived

  • issueprojectstring

    A project like a domain (inwendo.de) or a certain mail campaign

  • crm_projectCRMProject9

    CRM project the ticket belongs to.

    Show fields (19)
    • idinteger

      Primary key of the project. Internal ID.

    • namestring

      Name of the project.

    • closedstring (date-time)

      Time the project was closed.

    • billedstring (date-time)

      Time the project was billed.

    • numberstring

      Number of the project.

    • startstring (date-time)

      Start of the project.

    • endstring (date-time)

      End of the project.

    • descriptionstring

      Description of the project.

    • companyCRMCompany19

      Company the project belongs to.

    • internal_main_contactUser

      Internal login user who is the main contact.

    • categoryCRMProjectCategory

      Category of the project.

    • archivedboolean

      The project is archived.

    • visible_for_customerboolean

      The project is visible in the customer app.

    • name_for_customerstring

      Name of the project shown to customers.

    • invoice_emailstring

      E-mail address for invoices of the project.

    • time_report_emailstring

      E-mail address for time reports of the project.

    • search_stringstring

      Text that the entity can be searched by.

    • createdstring (date-time)

      Point in time the entity was created.

    • … 1 more fields
  • … 51 more fields
Request
curl --request POST \
  --url https://your-instance.iw-erp.de/api/crm/tickets/42/adds/attachments \
  --header 'x-iw-jwt-token: <TOKEN>'
Response 200 application/json
{
  "id": 42,
  "external_person_first_name": "Beispiel",
  "external_person_last_name": "Beispiel",
  "external_person_email": "lena.hartmann@example.org",
  "external_person_phone": "+49 511 123456",
  "external_person_address_city": "Hannover",
  "external_person_address_zip": "30163",
  "external_person_address_country": "DE",
  "external_company_name": "Beispiel",
  "external_company_email": "lena.hartmann@example.org"
}

Remove an Attachment from Ticket

POST/api/crm/tickets/{id}/deletes/attachments

Path parameters

idrequiredstring

Responses

200Remove an Attachment from TicketCustomerTicket3

Show fields (21)
  • satisfaction_requested_atstring

    When the customer / member was asked to rate the finished ticket; the apps offer the rating once this is set.

  • idinteger

    Primary key of the ticket. Internal ID.

  • ticket_typestring

    Type of the ticket.

  • numberinteger

    Running ticket number.

  • number_stringstring

    Ticket number as displayed to users.

  • companyCRMCompany19

    Company the ticket belongs to.

    Show fields (56)
    • idinteger

      Primary key of the company. Internal ID.

    • short_namestring

      Short name of the company.

    • company_namestring

      Legal name of the company.

    • secondary_namestring

      Second name line of the company.

    • direct_dialstring

      Direct dial number of the company.

    • invoice_emailstring

      E-mail address for invoices.

    • send_invoice_emailboolean

      Send invoices by e-mail.

    • send_invoice_letterboolean

      Send invoices by letter.

    • time_report_emailstring

      E-mail address for time reports.

    • payment_goalPaymentGoal

      Payment term of the company.

    • payment_intervalstring

      Interval of the payments.

    • vatidstring

      VAT identification number.

    • taxnumberstring

      Tax number of the company.

    • buyer_reference_idstring

      Leitweg-ID or custom reference ID defined by the customer

    • taxTax

      Tax rate used for the company.

    • infostring

      Information about the company.

    • numberstring

      Customer or supplier number of the company.

    • manual_numberinteger

      Number set manually instead of the automatic number.

    • number_stringstring

      Company number as text, including prefix.

    • is_customerboolean

      The company is a customer.

    • is_supplierboolean

      The company is a supplier.

    • is_otherboolean

      The company is neither customer nor supplier.

    • is_memberboolean

      The company is a member.

    • archivedboolean

      The company is archived.

    • categoryCRMCompanyCategory

      Category of the company.

    • visible_for_customerboolean

      Whether the company is visible to the customer.

    • founding_datestring (date-time)

      Founding date of the company.

    • nace_sectionstring

      NACE section code (letter A-U)

    • nace_codestring

      NACE code (numeric like 01.11, 62.01)

    • search_stringstring

      Text that the entity can be searched by.

    • addressstring

      Address as text.

    • address_streetstring

      Street of the address.

    • address_house_numberstring

      House number of the address.

    • address_street_levelstring

      Street and house number of the address.

    • address_costring

      Care-of line of the address.

    • address_citystring

      City of the address.

    • address_zipstring

      Postal code of the address.

    • address_admin_level1string

      First administrative level of the address, e.g. the federal state.

    • address_countrystring

      Country code of the address.

    • address_full_countrystring

      Full name of the country of the address.

    • address_geo_latstring

      Latitude of the address.

    • address_geo_lngstring

      Longitude of the address.

    • address_external_provider_idstring

      field to store the external provider id of the address. e.g. Google Maps PlaceID like google:ChIJVcKw5r90sEcRhdjNq6NItqE

    • main_phonestring

      Main phone number.

    • main_faxstring

      Main fax number.

    • main_emailstring

      Main e-mail address.

    • websitestring

      Website address.

    • createdstring (date-time)

      Point in time the entity was created.

    • updatedstring (date-time)

      Point in time the entity was last updated.

    • atagsarray<AccessTag>
    • payment_typePaymentType
    • company_employee_countinteger

      Number of employees of the company.

    • company_founding_yearinteger

      Founding year of the company.

    • company_family_ownedboolean

      Whether the company is family-owned.

    • company_sales_volumestring

      Sales volume of the company.

    • company_segmentstring

      Market segment of the company.

  • personCRMPerson10

    Person the ticket belongs to.

    Show fields (81)
    • idinteger

      Primary key of the person. Internal ID.

    • first_namestring

      First name of the person.

    • last_namestring

      Last name of the person.

    • numberinteger

      Member or customer number of the person.

    • manual_numberinteger

      Number set manually instead of the automatic number.

    • number_stringstring

      Member or customer number as text, including prefix.

    • genderstring

      Gender of the person.

    • titlestring

      Academic or other title of the person.

    • positionstring

      Position or role of the person.

    • languagestring

      Preferred language of the person.

    • special_salutationstring

      Special salutation text for letters.

    • form_of_salutationstring

      Form of salutation, for example formal or informal.

    • birthdaystring (date-time)

      Birthday of the person.

    • known_allergiesstring

      Known allergies of the person.

    • confirmed_no_allergiesboolean

      Guardian confirmed that there are no known allergies.

    • allow_photosboolean

      Photos of the person may be taken and published.

    • allow_leaving_aloneboolean

      The person may leave the event alone.

    • authorized_pickupstring

      Persons who are allowed to pick up the person.

    • needs_supportboolean

      The person needs support, for example for inclusion.

    • support_descriptionstring

      Description of the support the person needs.

    • financial_supportboolean

      The person receives financial support.

    • financial_support_numberstring

      Number of the financial support.

    • municipal_supportboolean

      The person receives municipal support.

    • municipal_support_numberstring

      Number of the municipal support.

    • grade_levelinteger

      School grade level of the person.

    • school_classstring

      School class of the person.

    • start_timestring (date-time)

      Start of the membership or activity.

    • start_time_reasonstring

      Reason for the start.

    • end_timestring (date-time)

      End of the membership or activity.

    • end_time_reasonstring

      Reason for the end.

    • confirmed_gtc_timestring (date-time)

      Time the general terms and conditions were confirmed.

    • chatbot_opt_inboolean

      Einwilligung in die Nutzung des KI-Assistenten. Denormalisierter aktueller Stand - das pruefbare Protokoll steht in ChatbotConsent.

    • chatbot_opt_in_atstring (date-time)

      Time the person opted in to the chatbot.

    • chatbot_opt_in_text_versionstring

      Version des Einwilligungstextes, dem zugestimmt wurde. Weicht sie von der aktuellen Version ab, ist das Opt-in abgelaufen.

    • app_usage_statistics_opt_outboolean

      Widerspruch gegen die anonyme Nutzungsstatistik der Mitglieder-App. Die App liest ihn aus den StaticData und schickt dann nichts mehr; die gezaehlten Aufrufe selbst haben keinen Bezug zur Person.

    • crm_person_contact_dataarray<CRMPersonContactData>

      Contact data of the person, for example phone and e-mail.

    • archivedboolean

      Whether the person is archived.

    • subscribed_newsletterboolean

      Whether the person subscribed to the newsletter.

    • subscribed_magazineboolean

      Whether the person subscribed to the magazine.

    • printed_member_cardboolean

      Whether a member card has been printed for the person.

    • has_login_userboolean

      Whether the person has a login user.

    • profile_picture_urlstring

      URL of the profile picture of the person.

    • log_book_staffboolean

      Log book flag: staff.

    • log_book_staff1boolean

      Log book flag: staff, level 1.

    • log_book_staff2boolean

      Log book flag: staff, level 2.

    • log_book_memberboolean

      Log book flag: member.

    • log_book_trainerboolean

      Log book flag: trainer.

    • log_book_trainer1boolean

      Log book flag: trainer, level 1.

    • log_book_trainer2boolean

      Log book flag: trainer, level 2.

    • log_book_head_of_departmentboolean

      Log book flag: head of department.

    • log_book_supervisory_boardboolean

      Log book flag: supervisory board.

    • log_book_board_of_directorsboolean

      Log book flag: board of directors.

    • log_book_honorary_memberboolean

      Log book flag: honorary member.

    • log_book_club_card_oneboolean

      Log book flag: club card.

    • log_book_health_recoveredboolean

      Log book flag: recovered from illness.

    • log_book_health_vaccinatedboolean

      Log book flag: vaccinated.

    • log_book_health_vaccinated_additionstring

      Details of the vaccination.

    • log_book_good_conductboolean

      Log book flag: certificate of good conduct.

    • log_book_first_aidboolean

      Log book flag: first aid training.

    • log_book_measles_vaccinationboolean

      Log book flag: measles vaccination.

    • sync_lanistaboolean

      Whether the person is synchronized with Lanista.

    • categoryCRMPersonCategory

      Person category.

    • nicknamestring

      Nickname of the person.

    • preferred_color_hexstring

      Preferred color of the person as hex value.

    • avatar_tokenstring

      Token of the avatar image.

    • search_stringstring

      Text that the entity can be searched by.

    • addressstring

      Address as text.

    • address_streetstring

      Street of the address.

    • address_house_numberstring

      House number of the address.

    • address_street_levelstring

      Street and house number of the address.

    • address_costring

      Care-of line of the address.

    • address_citystring

      City of the address.

    • address_zipstring

      Postal code of the address.

    • address_admin_level1string

      First administrative level of the address, e.g. the federal state.

    • address_countrystring

      Country code of the address.

    • address_full_countrystring

      Full name of the country of the address.

    • address_geo_latstring

      Latitude of the address.

    • address_geo_lngstring

      Longitude of the address.

    • address_external_provider_idstring

      field to store the external provider id of the address. e.g. Google Maps PlaceID like google:ChIJVcKw5r90sEcRhdjNq6NItqE

    • createdstring (date-time)

      Point in time the entity was created.

    • … 2 more fields
  • jirakeystring

    Key of the linked Jira issue.

  • jiraidstring

    ID of the linked Jira issue.

  • assignedusernamestring

    Name of the assigned user, as text.

  • assigned_userUser

    User the ticket is assigned to.

    Show fields (11)
    • idinteger

      Primary key of the user. Internal ID of the login user.

    • namestring

      Display name of the user. Shown in the UI and in audit entries.

    • usernamestring

      Login name of the user. Must be unique across all users.

    • emailstring

      E-mail address of the user. Used for login notifications, password resets and as a login alias.

    • user_access_groupUserAccessGroup3

      User access group of the user. Defines the rights of the user for all scopes.

    • positioningeneralstring

      Free text describing the position or role of the user.

    • crm_personCRMPerson10

      CRM person linked to this login user. Connects the login account with the person record.

    • profile_picture_urlstring

      URL of the profile picture of the user.

    • archivedboolean

      Marks the user as archived. Archived users are kept for history and are not active.

    • require2faboolean

      Two-factor authentication is required for this user.

    • search_stringstring

      Text that the entity can be searched by.

  • createdbyusernamestring

    Name of the user who created the ticket, as text.

  • created_by_userUser

    User who created the ticket.

    Show fields (11)
    • idinteger

      Primary key of the user. Internal ID of the login user.

    • namestring

      Display name of the user. Shown in the UI and in audit entries.

    • usernamestring

      Login name of the user. Must be unique across all users.

    • emailstring

      E-mail address of the user. Used for login notifications, password resets and as a login alias.

    • user_access_groupUserAccessGroup3

      User access group of the user. Defines the rights of the user for all scopes.

    • positioningeneralstring

      Free text describing the position or role of the user.

    • crm_personCRMPerson10

      CRM person linked to this login user. Connects the login account with the person record.

    • profile_picture_urlstring

      URL of the profile picture of the user.

    • archivedboolean

      Marks the user as archived. Archived users are kept for history and are not active.

    • require2faboolean

      Two-factor authentication is required for this user.

    • search_stringstring

      Text that the entity can be searched by.

  • statusstring

    Status of the ticket as text.

  • statusidstring

    ID of the status of the ticket.

  • issuetypestring

    A type like bug, task, story

  • issuecategorystring

    A category like website, hosting, marketing

  • crm_project_category_areaCRMProjectCategoryArea

    Project category area the ticket belongs to.

    Show fields (4)
    • idinteger

      Primary key of the category area. Internal ID.

    • namestring

      Name of the area.

    • descriptionstring

      Description of the area.

    • deletedboolean

      This property is used to mark an entity as deleted / archived

  • issueprojectstring

    A project like a domain (inwendo.de) or a certain mail campaign

  • crm_projectCRMProject9

    CRM project the ticket belongs to.

    Show fields (19)
    • idinteger

      Primary key of the project. Internal ID.

    • namestring

      Name of the project.

    • closedstring (date-time)

      Time the project was closed.

    • billedstring (date-time)

      Time the project was billed.

    • numberstring

      Number of the project.

    • startstring (date-time)

      Start of the project.

    • endstring (date-time)

      End of the project.

    • descriptionstring

      Description of the project.

    • companyCRMCompany19

      Company the project belongs to.

    • internal_main_contactUser

      Internal login user who is the main contact.

    • categoryCRMProjectCategory

      Category of the project.

    • archivedboolean

      The project is archived.

    • visible_for_customerboolean

      The project is visible in the customer app.

    • name_for_customerstring

      Name of the project shown to customers.

    • invoice_emailstring

      E-mail address for invoices of the project.

    • time_report_emailstring

      E-mail address for time reports of the project.

    • search_stringstring

      Text that the entity can be searched by.

    • createdstring (date-time)

      Point in time the entity was created.

    • … 1 more fields
  • … 51 more fields
Request
curl --request POST \
  --url https://your-instance.iw-erp.de/api/crm/tickets/42/deletes/attachments \
  --header 'x-iw-jwt-token: <TOKEN>'
Response 200 application/json
{
  "id": 42,
  "external_person_first_name": "Beispiel",
  "external_person_last_name": "Beispiel",
  "external_person_email": "lena.hartmann@example.org",
  "external_person_phone": "+49 511 123456",
  "external_person_address_city": "Hannover",
  "external_person_address_zip": "30163",
  "external_person_address_country": "DE",
  "external_company_name": "Beispiel",
  "external_company_email": "lena.hartmann@example.org"
}

Moves a Ticket on the kanban board / in the sprint planning

POST/api/crm/tickets/{id}/board_positions

A move can change the status (kanban column), the sprint and the manual position inside the column at once. Only the submitted values are applied.

Path parameters

idrequiredstring

Request body application/json

  • dataTicketBoardPositionRequest

Responses

200Move a Ticket on the boardCustomerTicket3

Show fields (21)
  • satisfaction_requested_atstring

    When the customer / member was asked to rate the finished ticket; the apps offer the rating once this is set.

  • idinteger

    Primary key of the ticket. Internal ID.

  • ticket_typestring

    Type of the ticket.

  • numberinteger

    Running ticket number.

  • number_stringstring

    Ticket number as displayed to users.

  • companyCRMCompany19

    Company the ticket belongs to.

    Show fields (56)
    • idinteger

      Primary key of the company. Internal ID.

    • short_namestring

      Short name of the company.

    • company_namestring

      Legal name of the company.

    • secondary_namestring

      Second name line of the company.

    • direct_dialstring

      Direct dial number of the company.

    • invoice_emailstring

      E-mail address for invoices.

    • send_invoice_emailboolean

      Send invoices by e-mail.

    • send_invoice_letterboolean

      Send invoices by letter.

    • time_report_emailstring

      E-mail address for time reports.

    • payment_goalPaymentGoal

      Payment term of the company.

    • payment_intervalstring

      Interval of the payments.

    • vatidstring

      VAT identification number.

    • taxnumberstring

      Tax number of the company.

    • buyer_reference_idstring

      Leitweg-ID or custom reference ID defined by the customer

    • taxTax

      Tax rate used for the company.

    • infostring

      Information about the company.

    • numberstring

      Customer or supplier number of the company.

    • manual_numberinteger

      Number set manually instead of the automatic number.

    • number_stringstring

      Company number as text, including prefix.

    • is_customerboolean

      The company is a customer.

    • is_supplierboolean

      The company is a supplier.

    • is_otherboolean

      The company is neither customer nor supplier.

    • is_memberboolean

      The company is a member.

    • archivedboolean

      The company is archived.

    • categoryCRMCompanyCategory

      Category of the company.

    • visible_for_customerboolean

      Whether the company is visible to the customer.

    • founding_datestring (date-time)

      Founding date of the company.

    • nace_sectionstring

      NACE section code (letter A-U)

    • nace_codestring

      NACE code (numeric like 01.11, 62.01)

    • search_stringstring

      Text that the entity can be searched by.

    • addressstring

      Address as text.

    • address_streetstring

      Street of the address.

    • address_house_numberstring

      House number of the address.

    • address_street_levelstring

      Street and house number of the address.

    • address_costring

      Care-of line of the address.

    • address_citystring

      City of the address.

    • address_zipstring

      Postal code of the address.

    • address_admin_level1string

      First administrative level of the address, e.g. the federal state.

    • address_countrystring

      Country code of the address.

    • address_full_countrystring

      Full name of the country of the address.

    • address_geo_latstring

      Latitude of the address.

    • address_geo_lngstring

      Longitude of the address.

    • address_external_provider_idstring

      field to store the external provider id of the address. e.g. Google Maps PlaceID like google:ChIJVcKw5r90sEcRhdjNq6NItqE

    • main_phonestring

      Main phone number.

    • main_faxstring

      Main fax number.

    • main_emailstring

      Main e-mail address.

    • websitestring

      Website address.

    • createdstring (date-time)

      Point in time the entity was created.

    • updatedstring (date-time)

      Point in time the entity was last updated.

    • atagsarray<AccessTag>
    • payment_typePaymentType
    • company_employee_countinteger

      Number of employees of the company.

    • company_founding_yearinteger

      Founding year of the company.

    • company_family_ownedboolean

      Whether the company is family-owned.

    • company_sales_volumestring

      Sales volume of the company.

    • company_segmentstring

      Market segment of the company.

  • personCRMPerson10

    Person the ticket belongs to.

    Show fields (81)
    • idinteger

      Primary key of the person. Internal ID.

    • first_namestring

      First name of the person.

    • last_namestring

      Last name of the person.

    • numberinteger

      Member or customer number of the person.

    • manual_numberinteger

      Number set manually instead of the automatic number.

    • number_stringstring

      Member or customer number as text, including prefix.

    • genderstring

      Gender of the person.

    • titlestring

      Academic or other title of the person.

    • positionstring

      Position or role of the person.

    • languagestring

      Preferred language of the person.

    • special_salutationstring

      Special salutation text for letters.

    • form_of_salutationstring

      Form of salutation, for example formal or informal.

    • birthdaystring (date-time)

      Birthday of the person.

    • known_allergiesstring

      Known allergies of the person.

    • confirmed_no_allergiesboolean

      Guardian confirmed that there are no known allergies.

    • allow_photosboolean

      Photos of the person may be taken and published.

    • allow_leaving_aloneboolean

      The person may leave the event alone.

    • authorized_pickupstring

      Persons who are allowed to pick up the person.

    • needs_supportboolean

      The person needs support, for example for inclusion.

    • support_descriptionstring

      Description of the support the person needs.

    • financial_supportboolean

      The person receives financial support.

    • financial_support_numberstring

      Number of the financial support.

    • municipal_supportboolean

      The person receives municipal support.

    • municipal_support_numberstring

      Number of the municipal support.

    • grade_levelinteger

      School grade level of the person.

    • school_classstring

      School class of the person.

    • start_timestring (date-time)

      Start of the membership or activity.

    • start_time_reasonstring

      Reason for the start.

    • end_timestring (date-time)

      End of the membership or activity.

    • end_time_reasonstring

      Reason for the end.

    • confirmed_gtc_timestring (date-time)

      Time the general terms and conditions were confirmed.

    • chatbot_opt_inboolean

      Einwilligung in die Nutzung des KI-Assistenten. Denormalisierter aktueller Stand - das pruefbare Protokoll steht in ChatbotConsent.

    • chatbot_opt_in_atstring (date-time)

      Time the person opted in to the chatbot.

    • chatbot_opt_in_text_versionstring

      Version des Einwilligungstextes, dem zugestimmt wurde. Weicht sie von der aktuellen Version ab, ist das Opt-in abgelaufen.

    • app_usage_statistics_opt_outboolean

      Widerspruch gegen die anonyme Nutzungsstatistik der Mitglieder-App. Die App liest ihn aus den StaticData und schickt dann nichts mehr; die gezaehlten Aufrufe selbst haben keinen Bezug zur Person.

    • crm_person_contact_dataarray<CRMPersonContactData>

      Contact data of the person, for example phone and e-mail.

    • archivedboolean

      Whether the person is archived.

    • subscribed_newsletterboolean

      Whether the person subscribed to the newsletter.

    • subscribed_magazineboolean

      Whether the person subscribed to the magazine.

    • printed_member_cardboolean

      Whether a member card has been printed for the person.

    • has_login_userboolean

      Whether the person has a login user.

    • profile_picture_urlstring

      URL of the profile picture of the person.

    • log_book_staffboolean

      Log book flag: staff.

    • log_book_staff1boolean

      Log book flag: staff, level 1.

    • log_book_staff2boolean

      Log book flag: staff, level 2.

    • log_book_memberboolean

      Log book flag: member.

    • log_book_trainerboolean

      Log book flag: trainer.

    • log_book_trainer1boolean

      Log book flag: trainer, level 1.

    • log_book_trainer2boolean

      Log book flag: trainer, level 2.

    • log_book_head_of_departmentboolean

      Log book flag: head of department.

    • log_book_supervisory_boardboolean

      Log book flag: supervisory board.

    • log_book_board_of_directorsboolean

      Log book flag: board of directors.

    • log_book_honorary_memberboolean

      Log book flag: honorary member.

    • log_book_club_card_oneboolean

      Log book flag: club card.

    • log_book_health_recoveredboolean

      Log book flag: recovered from illness.

    • log_book_health_vaccinatedboolean

      Log book flag: vaccinated.

    • log_book_health_vaccinated_additionstring

      Details of the vaccination.

    • log_book_good_conductboolean

      Log book flag: certificate of good conduct.

    • log_book_first_aidboolean

      Log book flag: first aid training.

    • log_book_measles_vaccinationboolean

      Log book flag: measles vaccination.

    • sync_lanistaboolean

      Whether the person is synchronized with Lanista.

    • categoryCRMPersonCategory

      Person category.

    • nicknamestring

      Nickname of the person.

    • preferred_color_hexstring

      Preferred color of the person as hex value.

    • avatar_tokenstring

      Token of the avatar image.

    • search_stringstring

      Text that the entity can be searched by.

    • addressstring

      Address as text.

    • address_streetstring

      Street of the address.

    • address_house_numberstring

      House number of the address.

    • address_street_levelstring

      Street and house number of the address.

    • address_costring

      Care-of line of the address.

    • address_citystring

      City of the address.

    • address_zipstring

      Postal code of the address.

    • address_admin_level1string

      First administrative level of the address, e.g. the federal state.

    • address_countrystring

      Country code of the address.

    • address_full_countrystring

      Full name of the country of the address.

    • address_geo_latstring

      Latitude of the address.

    • address_geo_lngstring

      Longitude of the address.

    • address_external_provider_idstring

      field to store the external provider id of the address. e.g. Google Maps PlaceID like google:ChIJVcKw5r90sEcRhdjNq6NItqE

    • createdstring (date-time)

      Point in time the entity was created.

    • … 2 more fields
  • jirakeystring

    Key of the linked Jira issue.

  • jiraidstring

    ID of the linked Jira issue.

  • assignedusernamestring

    Name of the assigned user, as text.

  • assigned_userUser

    User the ticket is assigned to.

    Show fields (11)
    • idinteger

      Primary key of the user. Internal ID of the login user.

    • namestring

      Display name of the user. Shown in the UI and in audit entries.

    • usernamestring

      Login name of the user. Must be unique across all users.

    • emailstring

      E-mail address of the user. Used for login notifications, password resets and as a login alias.

    • user_access_groupUserAccessGroup3

      User access group of the user. Defines the rights of the user for all scopes.

    • positioningeneralstring

      Free text describing the position or role of the user.

    • crm_personCRMPerson10

      CRM person linked to this login user. Connects the login account with the person record.

    • profile_picture_urlstring

      URL of the profile picture of the user.

    • archivedboolean

      Marks the user as archived. Archived users are kept for history and are not active.

    • require2faboolean

      Two-factor authentication is required for this user.

    • search_stringstring

      Text that the entity can be searched by.

  • createdbyusernamestring

    Name of the user who created the ticket, as text.

  • created_by_userUser

    User who created the ticket.

    Show fields (11)
    • idinteger

      Primary key of the user. Internal ID of the login user.

    • namestring

      Display name of the user. Shown in the UI and in audit entries.

    • usernamestring

      Login name of the user. Must be unique across all users.

    • emailstring

      E-mail address of the user. Used for login notifications, password resets and as a login alias.

    • user_access_groupUserAccessGroup3

      User access group of the user. Defines the rights of the user for all scopes.

    • positioningeneralstring

      Free text describing the position or role of the user.

    • crm_personCRMPerson10

      CRM person linked to this login user. Connects the login account with the person record.

    • profile_picture_urlstring

      URL of the profile picture of the user.

    • archivedboolean

      Marks the user as archived. Archived users are kept for history and are not active.

    • require2faboolean

      Two-factor authentication is required for this user.

    • search_stringstring

      Text that the entity can be searched by.

  • statusstring

    Status of the ticket as text.

  • statusidstring

    ID of the status of the ticket.

  • issuetypestring

    A type like bug, task, story

  • issuecategorystring

    A category like website, hosting, marketing

  • crm_project_category_areaCRMProjectCategoryArea

    Project category area the ticket belongs to.

    Show fields (4)
    • idinteger

      Primary key of the category area. Internal ID.

    • namestring

      Name of the area.

    • descriptionstring

      Description of the area.

    • deletedboolean

      This property is used to mark an entity as deleted / archived

  • issueprojectstring

    A project like a domain (inwendo.de) or a certain mail campaign

  • crm_projectCRMProject9

    CRM project the ticket belongs to.

    Show fields (19)
    • idinteger

      Primary key of the project. Internal ID.

    • namestring

      Name of the project.

    • closedstring (date-time)

      Time the project was closed.

    • billedstring (date-time)

      Time the project was billed.

    • numberstring

      Number of the project.

    • startstring (date-time)

      Start of the project.

    • endstring (date-time)

      End of the project.

    • descriptionstring

      Description of the project.

    • companyCRMCompany19

      Company the project belongs to.

    • internal_main_contactUser

      Internal login user who is the main contact.

    • categoryCRMProjectCategory

      Category of the project.

    • archivedboolean

      The project is archived.

    • visible_for_customerboolean

      The project is visible in the customer app.

    • name_for_customerstring

      Name of the project shown to customers.

    • invoice_emailstring

      E-mail address for invoices of the project.

    • time_report_emailstring

      E-mail address for time reports of the project.

    • search_stringstring

      Text that the entity can be searched by.

    • createdstring (date-time)

      Point in time the entity was created.

    • … 1 more fields
  • … 51 more fields
Request
curl --request POST \
  --url https://your-instance.iw-erp.de/api/crm/tickets/42/board_positions \
  --header 'content-type: application/json' \
  --header 'x-iw-jwt-token: <TOKEN>' \
  --data '{}'
Response 200 application/json
{
  "id": 42,
  "external_person_first_name": "Beispiel",
  "external_person_last_name": "Beispiel",
  "external_person_email": "lena.hartmann@example.org",
  "external_person_phone": "+49 511 123456",
  "external_person_address_city": "Hannover",
  "external_person_address_zip": "30163",
  "external_person_address_country": "DE",
  "external_company_name": "Beispiel",
  "external_company_email": "lena.hartmann@example.org"
}