CRcraftboxx
My

Updates the logged-in company settings

Changed on
put/my/company/settings

Request

  • Base URL
    https://api.craftboxx.de
  • Auth
    HTTP bearer

Request body multipart/form-data

allow_overlapping_tools_vehiclesboolean

Can tools & vehicles being planned in the same period for multiple appointments?

allow_overlapping_employeesboolean

Can employees being planned in the same period for multiple appointments?

show_sequential_custom_numbersboolean

Show sequential numbers in the project/customer number input?

suggestions_project_containstring nullable

Suggestions project contain (For project number suggestions: What should be the prefix / nummernkreis)

show_shareable_linkboolean

Showing a link to share is possible?

force_unique_custom_numbersboolean

Project numbers have to be unique?

unplanned_assignments_app'HIDE' | 'SUGGEST' | 'DIRECT'

Show unplanned appointments in the app? (values: HIDE, SUGGEST = send email to responsible person in the office, DIRECT = direct scheduling and changing)

project_assignments_visibility_app'ASSIGNED_ONLY' | 'ALL'

Can employees see other appointments of an project in the app? (values: ASSIGNED_ONLY, ALL)

create_assignments_appboolean

Create assignments app (can employees create appointments in the app?)

unassigned_assignments_self_assign_appboolean

Show unassigned appointments in the app?

unassigned_assignments_visible_appboolean

Also show appointments without employees in the app, on top of project_assignments_visibility_app?

material_change_documentationboolean

Enable material change documentation?

assignments_max_start_app'ALL' | 'TOMORROW' | 'THREE_DAYS' | 'ONE_WEEK' | 'TWO_WEEKS' | 'FOUR_WEEKS'

Maximum start time for assignments in the app

disable_timesheet_edit_appboolean

Disable timesheet editing in the app?

activity_position_app'DISABLED' | 'OPTIONAL' | 'REQUIRED'

GPS position handling during time tracking in the app (DISABLED = never asked for, OPTIONAL = asked for but time tracking works without it, REQUIRED = mandatory to track time)

enable_auto_breakboolean

Enable automatic break?

pdf_logo_align'LEFT' | 'CENTER' | 'RIGHT'

For pdf, position (values: LEFT, CENTER, RIGHT)

calendar_day_startstring

For calendar/planning board: calendar_day_start (like 08:00)

calendar_day_endstring

For calendar/planning board: calendar day end (like 17:30)

remind_assignment_start'NEVER' | 'FIFTEEN_MINUTES' | 'THIRTY_MINUTES' | 'ONE_HOUR'

How much time to remind on the appointment before (values: NEVER,FIFTEEN_MINUTEs,THIRTY_MINUTES,ONE_HOUR)

notify_assignment_change_scope'TODAY_OR_TOMORROW' | 'ALL'

Employees should be notified about time changes, if the appointment is scheduled for a certain period (TODAY_OR_TOMORROW, ALL)

person_day_lengthinteger

Person day length (minutes)

show_person_daysboolean

Show person days?

default_holidays_per_yearinteger

Default holidays per year (for new employees)

show_project_sales_volumeboolean

Show project sales volume?

edit_project_sales_volume_in_plannerboolean

Edit project sales volume in planner?

show_target_timeboolean

Show target time?

edit_target_time_in_plannerboolean

Edit target time in planner?

currency'EUR' | 'USD' | 'CHF' | 'PLN' | 'RON' | 'UAH'

Currency

Response

Settings

Example response

{
  "data": {
    "id": 1,
    "allow_overlapping_employees": true,
    "show_sequential_custom_numbers": true,
    "show_shareable_link": true,
    "force_unique_custom_numbers": true,
    "suggestions_project_contain": "1000-2000",
    "unplanned_assignments_app": "DIRECT",
    "unassigned_assignments_visible_app": true,
    "material_change_documentation": true,
    "project_assignments_visibility_app": "ALL",
    "assignments_max_start_app": "FOUR_WEEKS",
    "create_assignments_app": true,
    "activity_position_app": "DISABLED",
    "pdf_logo_align": "CENTER",
    "calendar_day_start": "08:00",
    "calendar_day_end": "17:00",
    "remind_assignment_start": "ONE_HOUR",
    "notify_assignment_change_scope": "TODAY_OR_TOMORROW",
    "currency": "EUR",
    "first_line": "company settings 1",
    "person_day_length": 510,
    "default_holidays_per_year": 25
  }
}

Changes

  • 019228f63d6eRevision changes
    • info

      added the new optional request property

    • info

      added the optional property / to the response with the status

  • e5970932f855Revision changes
    • warning

      removed the request property

    • warning

      removed the optional property / from the response with the status

    • warning

      added the new PROJECT enum value to the / response property for the response status

    • info

      added the new optional request property

    • info

      added the optional property / to the response with the status

    • info

      added the optional property / to the response with the status