API Documentation PlanningNow

A guide to integrating with our API.

Important Note on API Structure

This API is designed for managing orders, work schedules, and cost centres. Please be aware that the endpoints and data structures outlined in this documentation are definitive. External systems intending to integrate must adapt to the specified request and response formats, as the API structure will not be customized for individual integrations.

1. Create and Manage API Tokens

API tokens are managed on a per-user basis. Each user can have only one active API token. Follow these steps to create a token for a specific user:

Step 1: Navigate to User Management

First, go to User Management in your PlanningNow web app and select the user for whom you want to generate or manage an API token.

Select the desired user account.

Step 2: Access API Key Settings

With the user selected, click on the API Key icon located in the right sidebar to open the token management interface.

Click the icon to manage the user's API token.

Step 3: Generate a New Token

In the token management overview, click the "Add" button on the right to generate a new API token. If a token already exists, you may need to revoke it first.

The token management overview.

Step 4: Copy Your New Token

The newly generated token will be displayed. This is the only time the token will be shown. Copy it and store it in a secure location. If you lose the token, you will need to revoke it and generate a new one.

Your new API token.

2. Using Your API Token

To authenticate your requests, you must send the API token in the HTTP header with every request. Use the header key X-AUTH-TOKEN.

Example Header:

X-AUTH-TOKEN: your_personal_api_token_here

API Endpoints

Order Management

Retrieves a list of all order confirmations in the system.

Example Response (200 OK):

[
    {
        "id": 3456,
        "o_conf_date": "2025-08-15",
        "employee_no": 101,
        "employee_name": "John Doe",
        "customer_no": 1234,
        "customer_name": "Example Corp",
        "project_no": "PROJ-2025-Q3",
        "subject": "Manufacturing services agreement",
        "netto": "8500.00",
        "ges_brutto": "10115.00"
    },
    {
        "id": 3457,
        "o_conf_date": "2025-08-20",
        "employee_no": 102,
        "employee_name": "Jane Smith",
        "customer_no": 5678,
        "customer_name": "Tech Industries",
        "project_no": "PROJ-2025-Q4",
        "subject": "Consulting services",
        "netto": "12000.00",
        "ges_brutto": "14280.00"
    }
]

Response Body Fields (Array of Objects):

[
    {
        "id": "integer (not null)",
        "o_conf_date": "date (nullable)",
        "employee_no": "integer (nullable)",
        "employee_name": "varchar (nullable)",
        "customer_no": "integer (nullable)",
        "customer_name": "varchar (nullable)",
        "project_no": "varchar (nullable)",
        "subject": "varchar (nullable)",
        "netto": "decimal (nullable)",
        "ges_netto": "decimal (nullable)",
        "ges_brutto": "decimal (not null)",
        "ges_mwst": "decimal (not null)",
        // ... summary fields from each order ...
    }
]

Retrieves the details of a specific order using its unique ID.

Example Response (200 OK):

{
    "id": 4711,
    "o_conf_date": "2025-09-11",
    "customer_no": 1234,
    "customer_name": "Example Corp",
    "project_no": "PROJ-2025-Q4",
    "subject": "Q4 Production Run",
    "netto": "1575.00",
    "ges_brutto": "1874.25",
    "positions": [
        {
            "id": 1,
            "pos_no": 1,
            "article_number": "ART-001",
            "article_desc": "Main Component Assembly",
            "amount": "50.00",
            "unit": "pcs",
            "unit_price": "25.00",
            "netto": "1250.00",
            "deliv_date": "2025-10-15",
            "tasks": [
                {
                    "id": 101,
                    "cost_centre_name": "Assembly Line 1",
                    "activity_name": "Component Welding",
                    "min_ruest": "30.00",
                    "min_wage": "5.50",
                    "min_masch": "7.20",
                    "production_start": "2025-09-20T08:00:00Z",
                    "production_end": "2025-09-20T16:30:00Z"
                }
            ]
        }
    ]
}

Response Body Fields:

{
    "id": "integer (not null)",
    "o_conf_date": "date (not null)",
    "employee_no": "varchar (nullable)",
    "zu_haenden": "varchar (nullable)",
    "addressfield_1": "varchar (nullable)",
    "addressfield_2": "varchar (nullable)",
    "addressfield_3": "varchar (nullable)",
    "street": "varchar (nullable)",
    "zipcode": "varchar (nullable)",
    "city": "varchar (nullable)",
    "lkz": "varchar (nullable)",
    "country": "varchar (nullable)",
    "customer_no": "integer (nullable)",
    "project_no": "varchar (nullable)",
    "lead_text": "longtext (nullable)",
    "followup_text": "longtext (nullable)",
    "date_desired": "date (nullable)",
    "delivery_date": "date (nullable)",
    "netto": "decimal (not null)",
    "ges_netto": "decimal (not null)",
    "ges_rabatt": "decimal (not null)",
    "info": "longtext (nullable)",
    "last_dn_id": "integer (nullable)",
    "last_dn_date": "date (nullable)",
    "last_invoice_id": "integer (nullable)",
    "last_invoice_date": "date (nullable)",
    "pay_term_id": "integer (nullable)",
    "pay_term_text": "varchar (nullable)",
    "skonto": "decimal (nullable)",
    "skonto_days": "decimal (nullable)",
    "netto_days": "decimal (nullable)",
    "mwst_key": "integer (nullable)",
    "mwst_calc": "tinyint (nullable)",
    "mwst_percent": "decimal (nullable)",
    "ges_brutto": "decimal (not null)",
    "ges_mwst": "decimal (not null)",
    "rabatt": "decimal (not null)",
    "deliv_term_id": "integer (nullable)",
    "deliv_term_text": "varchar (nullable)",
    "tour_id": "integer (nullable)",
    "tour_text": "varchar (nullable)",
    "ship_meth_id": "integer (nullable)",
    "ship_meth_text": "varchar (nullable)",
    "trans_vers": "decimal (nullable)",
    "ship_costs": "decimal (nullable)",
    "ship_date": "date (nullable)",
    "deliv_kw": "integer (nullable)",
    "deliv_year": "integer (nullable)",
    "deliv_text": "varchar (nullable)",
    "pack_cost": "decimal (nullable)",
    "freight_charge": "decimal (nullable)",
    "customs": "decimal (nullable)",
    "cus_phone_no": "varchar (nullable)",
    "cus_mail_address": "varchar (nullable)",
    "cus_mobile_no": "varchar (nullable)",
    "d_addressline1": "varchar (nullable)",
    "d_street": "varchar (nullable)",
    "d_zipcode": "varchar (nullable)",
    "d_city": "varchar (nullable)",
    "d_country": "varchar (nullable)",
    "d_state": "varchar (nullable)",
    "d_lkz": "varchar (nullable)",
    "r_addressline1": "varchar (nullable)",
    "r_street": "varchar (nullable)",
    "r_zipcode": "varchar (nullable)",
    "r_city": "varchar (nullable)",
    "r_lkz": "varchar (nullable)",
    "r_country": "varchar (nullable)",
    "r_state": "varchar (nullable)",
    "cus_pa_id": "integer (nullable)",
    "document_until": "date (nullable)",
    "order_lead_value": "decimal (nullable)",
    "subject": "varchar (nullable)",
    "to_offer": "integer (nullable)",
    "ext_order_no": "varchar (nullable)",
    "ext_order_date": "date (nullable)",
    "ext_order_staff": "varchar (nullable)",
    "short_info": "varchar (nullable)",
    "cmdate": "datetime (nullable)",
    "customer_name": "varchar (nullable)",
    "val_of_goods": "decimal (nullable)",
    "positions": [
        {
            "id": "integer (not null)",
            "pos_no": "smallint (not null)",
            "article_number": "varchar (nullable)",
            "article_desc": "varchar (nullable)",
            "amount": "decimal (not null)",
            "drawing_number": "varchar (nullable)",
            "unit": "varchar (nullable)",
            "pos_proj_no": "varchar (nullable)",
            "unit_price": "decimal (not null)",
            "discount": "decimal (not null)",
            "unit_price_disc": "decimal (not null)",
            "netto": "decimal (not null)",
            "deliv_date": "date (nullable)",
            "desired_date": "date (nullable)",
            "amount_delivered": "decimal (not null)",
            "amount_open": "decimal (not null)",
            "revision": "varchar (nullable)",
            "remarks": "longtext (nullable)",
            "mwst_percent": "decimal (not null)",
            "brutto": "decimal (not null)",
            "article_type": "smallint (nullable)",
            "shipping_date": "date (nullable)",
            "completion_date": "date (nullable)",
            "status": "integer (not null)",
            "production_quantity": "integer (nullable)",
            "priority": "integer (nullable)",
            "order_confirmation_form_start_date": "date (nullable)",
            "order_confirmation_form_end_date": "date (nullable)",
            "order_confirmation_form_remarks": "longtext (nullable)",
            "pdarelevant": "tinyint (nullable)",
            "preamble_text": "varchar (nullable)",
            "tasks": [
                {
                    "id": "integer (not null)",
                    "ws_pos": "smallint (nullable)",
                    "cost_centre": "integer (nullable)",
                    "cost_centre_name": "varchar (nullable)",
                    "activity": "integer (nullable)",
                    "activity_name": "varchar (nullable)",
                    "los_stueck": "tinyint (nullable)",
                    "wagegroup": "integer (nullable)",
                    "min_ruest": "decimal (nullable)",
                    "min_wage": "decimal (nullable)",
                    "sum_cost_wage": "decimal (nullable)",
                    "min_masch": "decimal (nullable)",
                    "sum_min_masch": "decimal (nullable)",
                    "sum_cost_masch": "decimal (nullable)",
                    "sum_pos": "decimal (nullable)",
                    "sum_min": "decimal (nullable)",
                    "min_cost_wage": "decimal (nullable)",
                    "ap_amount": "decimal (nullable)",
                    "amount": "decimal (nullable)",
                    "sum_min_wage": "decimal (nullable)",
                    "kalk_id": "integer (not null)",
                    "total_setup_min": "decimal (nullable)",
                    "fkt_setup_min": "decimal (nullable)",
                    "setup_costs": "decimal (nullable)",
                    "fkt_machinecost": "decimal (nullable)",
                    "wz_durable": "decimal (nullable)",
                    "wz_ek_price": "decimal (nullable)",
                    "wz_costs": "decimal (nullable)",
                    "production_start": "datetime (nullable)",
                    "external_work_id": "varchar (nullable)",
                    "fix_price": "decimal (nullable)",
                    "group_no": "varchar (nullable)",
                    "ff_pos": "varchar (nullable)",
                    "setup_id": "varchar (nullable)",
                    "staffgroup_id": "varchar (nullable)",
                    "costcentregroup_id": "varchar (nullable)",
                    "overlap": "decimal (nullable)",
                    "ab_ticket": "tinyint (nullable)",
                    "plan_time": "tinyint (nullable)",
                    "plan_min": "varchar (nullable)",
                    "service_location": "varchar (nullable)",
                    "return_location": "varchar (nullable)",
                    "advance_min": "varchar (nullable)",
                    "overrun_min": "varchar (nullable)",
                    "estimated": "tinyint (nullable)",
                    "belongs_to_id": "integer (nullable)",
                    "article_no": "varchar (nullable)",
                    "parts_list_kalk_id": "integer (nullable)",
                    "remarks": "longtext (nullable)",
                    "ew_article": "varchar (nullable)",
                    "ew_amount": "decimal (nullable)",
                    "ew_planned_exit_date": "date (nullable)",
                    "ew_exit_date": "date (nullable)",
                    "ew_planned_entrance_date": "date (nullable)",
                    "return_article": "varchar (nullable)",
                    "production_end": "datetime (nullable)",
                    "wage_factor_type": "varchar (nullable)",
                    "ew_entrance_date": "date (nullable)",
                    "done_date": "datetime (nullable)",
                    "in_order": "double (nullable)",
                    "not_in_order": "double (nullable)",
                    "progress": "double (nullable)",
                    "done": "tinyint (nullable)",
                    "cm_status": "varchar (nullable)"
                }
            ]
        }
    ]
}

Creates a new order with the data provided in the request body.

Example Request Body:

{
    "o_conf_date": "2025-09-11",
    "customer_no": 5678,
    "project_no": "NEW-PROJ-01",
    "subject": "Initial Prototype Order",
    "delivery_date": "2025-11-01",
    "positions": [
        {
            "pos_no": 1,
            "article_number": "PROTO-X1",
            "article_desc": "Prototype Mainframe",
            "amount": "5.00",
            "unit": "pcs",
            "unit_price": "550.00",
            "remarks": "Handle with care, urgent delivery."
        }
    ]
}

Request Body Fields:

{
    "o_conf_date": "date (not null)",
    "customer_no": "integer (nullable)",
    // ... all other fields from order_conf are available ...
    "positions": [
        {
            "pos_no": "smallint (not null)",
            "article_number": "varchar (nullable)",
            "amount": "decimal (not null)",
            "unit_price": "decimal (not null)",
            // ... all other fields from order_conf_pos are available ...
            "tasks": [
                 {
                    "activity_name": "varchar (nullable)",
                    // ... all other fields from aufzeitpos are available ...
                 }
            ]
        }
    ]
}

Updates an existing order. Any field of the order, its positions, or tasks can be updated.

Example Request Body:

{
    "subject": "Q4 Production Run (Revised)",
    "delivery_date": "2025-10-20",
    "short_info": "Delivery date expedited per customer request."
}

Request Body Fields:

{
    // Any field from the order object (see GET /api/order/{id}) can be included here to update it.
}

Offer Management

Retrieves a list of all offers in the system.

Example Response (200 OK):

[
    {
        "id": 2345,
        "offer_date": "2025-09-05",
        "customer_no": 1234,
        "customer_name": "Example Corp",
        "project_no": "PROJ-2025-Q3",
        "subject": "Initial project proposal",
        "netto": "2500.00",
        "ges_brutto": "2975.00"
    },
    {
        "id": 2346,
        "offer_date": "2025-09-10",
        "customer_no": 5678,
        "customer_name": "Tech Industries",
        "project_no": "PROJ-2025-Q4",
        "subject": "Advanced manufacturing proposal",
        "netto": "5000.00",
        "ges_brutto": "5950.00"
    }
]

Response Body Fields (Array of Objects):

[
    {
        "id": "integer (not null)",
        "offer_date": "date (nullable)",
        "customer_no": "integer (nullable)",
        "customer_name": "varchar (nullable)",
        "project_no": "varchar (nullable)",
        "subject": "varchar (nullable)",
        "netto": "decimal (nullable)",
        "ges_netto": "decimal (nullable)",
        "ges_brutto": "decimal (not null)",
        "ges_mwst": "decimal (not null)",
        // ... summary fields from each offer ...
    }
]

Retrieves the details of a specific offer using its unique ID.

Example Response (200 OK):

{
    "id": 2345,
    "offer_date": "2025-09-05",
    "customer_no": 1234,
    "project_no": "PROJ-2025-Q3",
    "lead_text": "Initial project proposal",
    "followup_text": "Follow-up discussion required",
    "date_desired": "2025-10-01",
    "delivery_date": "2025-10-15",
    "netto": "2500.00",
    "ges_netto": "2500.00",
    "ges_rabatt": "0.00",
    "info": "Special pricing for bulk order",
    "pay_term_id": 1,
    "pay_term_text": "Net 30 days",
    "positions": [
        {
            "id": 1,
            "pos_no": 1,
            "article_number": "COMP-001",
            "article_desc": "Main Component",
            "amount": "25.00",
            "unit": "pcs",
            "unit_price": "100.00",
            "discount": "0.00",
            "unit_price_disc": "100.00",
            "netto": "2500.00",
            "deliv_date": "2025-10-15",
            "mwst_percent": "19.00",
            "brutto": "2975.00",
            "tasks": [
                {
                    "id": 101,
                    "kalk_id": 1,
                    "cost_centre_name": "Assembly Line 2",
                    "activity_name": "Component Assembly",
                    "min_ruest": "20.00",
                    "min_wage": "3.50",
                    "min_masch": "5.00"
                }
            ]
        }
    ]
}

Response Body Fields:

{
    "id": "integer (not null)",
    "offer_date": "date (nullable)",
    "employee_no": "varchar (nullable)",
    "zu_haenden": "varchar (nullable)",
    "addressfield_1": "varchar (nullable)",
    "addressfield_2": "varchar (nullable)",
    "addressfield_3": "varchar (nullable)",
    "street": "varchar (nullable)",
    "zipcode": "varchar (nullable)",
    "city": "varchar (nullable)",
    "lkz": "varchar (nullable)",
    "country": "varchar (nullable)",
    "customer_no": "integer (nullable)",
    "project_no": "varchar (nullable)",
    "lead_text": "longtext (nullable)",
    "followup_text": "longtext (nullable)",
    "date_desired": "date (nullable)",
    "delivery_date": "date (nullable)",
    "netto": "decimal (nullable)",
    "ges_netto": "decimal (nullable)",
    "ges_rabatt": "decimal (nullable)",
    "info": "longtext (nullable)",
    "last_oconf_id": "integer (nullable)",
    "last_oconf_date": "date (nullable)",
    "pay_term_id": "integer (nullable)",
    "pay_term_text": "varchar (nullable)",
    "positions": [
        {
            "id": "integer (not null)",
            "pos_no": "smallint (not null)",
            "article_number": "varchar (nullable)",
            "article_desc": "varchar (nullable)",
            "amount": "decimal (not null)",
            "drawing_number": "varchar (nullable)",
            "unit": "varchar (nullable)",
            "pos_proj_no": "varchar (nullable)",
            "unit_price": "decimal (not null)",
            "discount": "decimal (not null)",
            "unit_price_disc": "decimal (not null)",
            "netto": "decimal (not null)",
            "deliv_date": "date (nullable)",
            "desired_date": "date (nullable)",
            "amount_delivered": "decimal (nullable)",
            "amount_open": "decimal (nullable)",
            "revision": "varchar (nullable)",
            "remarks": "longtext (nullable)",
            "mwst_percent": "decimal (nullable)",
            "brutto": "decimal (nullable)",
            "article_type": "smallint (nullable)",
            "tasks": [
                {
                    "id": "integer (not null)",
                    "kalk_id": "integer (not null)",
                    "ws_pos": "smallint (nullable)",
                    "cost_centre": "integer (nullable)",
                    "cost_centre_name": "varchar (nullable)",
                    "activity": "integer (nullable)",
                    "activity_name": "varchar (nullable)",
                    "los_stueck": "tinyint (nullable)",
                    "wagegroup": "integer (nullable)",
                    "min_ruest": "decimal (nullable)",
                    "min_wage": "decimal (nullable)",
                    "sum_cost_wage": "decimal (nullable)",
                    "min_masch": "decimal (nullable)",
                    "sum_min_masch": "decimal (nullable)",
                    "sum_cost_masch": "decimal (nullable)",
                    "sum_pos": "decimal (nullable)",
                    "sum_min": "decimal (nullable)",
                    "min_cost_wage": "decimal (nullable)",
                    "ap_amount": "decimal (nullable)",
                    "amount": "decimal (nullable)",
                    "sum_min_wage": "decimal (nullable)"
                }
            ]
        }
    ]
}

Creates a new offer with the data provided in the request body.

Example Request Body:

{
    "offer_date": "2025-09-25",
    "customer_no": 9876,
    "project_no": "NEW-OFFER-01",
    "lead_text": "Initial consultation and proposal",
    "delivery_date": "2025-11-30",
    "pay_term_text": "Net 45 days",
    "positions": [
        {
            "pos_no": 1,
            "article_number": "SERV-X1",
            "article_desc": "Consulting Services",
            "amount": "20.00",
            "unit": "hrs",
            "unit_price": "125.00",
            "remarks": "Senior consultant rate applies."
        }
    ]
}

Request Body Fields:

{
    "offer_date": "date (nullable)",
    "customer_no": "integer (nullable)",
    "project_no": "varchar (nullable)",
    "lead_text": "longtext (nullable)",
    "followup_text": "longtext (nullable)",
    "date_desired": "date (nullable)",
    "delivery_date": "date (nullable)",
    "netto": "decimal (nullable)",
    "ges_netto": "decimal (nullable)",
    "ges_rabatt": "decimal (nullable)",
    "info": "longtext (nullable)",
    "pay_term_id": "integer (nullable)",
    "pay_term_text": "varchar (nullable)",
    // ... all other fields from offer table are available ...
    "positions": [
        {
            "pos_no": "smallint (not null)",
            "article_number": "varchar (nullable)",
            "article_desc": "varchar (nullable)",
            "amount": "decimal (not null)",
            "unit_price": "decimal (not null)",
            // ... all other fields from offer_pos are available ...
            "tasks": [
                 {
                    "activity_name": "varchar (nullable)",
                    // ... all other fields from aufzeitpos are available ...
                 }
            ]
        }
    ]
}

Updates an existing offer. Any field of the offer, its positions, or tasks can be updated.

Example Request Body:

{
    "lead_text": "Updated proposal with revised requirements",
    "delivery_date": "2025-12-15",
    "info": "Delivery date extended per customer request."
}

Request Body Fields:

{
    // Any field from the offer object (see GET /api/offer/{id}) can be included here to update it.
}

Work Schedules

Retrieves a specific work schedule.

{
    "id": 101,
    "name": "Standard Assembly Process",
    "creation_date": "2025-01-10",
    "sum_cost": "125.50",
    "los_stueck": 1,
    "positions": [
        {
            "id": 201,
            "pos": 10,
            "cost_centre_name": "Milling Department",
            "activity_name": "CNC Milling Part A",
            "min_ruest": "15.00",
            "min_wage": "2.50",
            "sum_cost_wage": "12.50",
            "min_masch": "10.00",
            "sum_cost_masch": "20.00"
        }
    ]
}

Response Body Fields:

{
    "id": "integer (not null)",
    "name": "varchar (not null)",
    "creation_date": "date (nullable)",
    "last_change_date": "date (nullable)",
    "sum_min_ruest": "decimal (nullable)",
    "sum_min": "decimal (nullable)",
    "sum_min_masch": "decimal (nullable)",
    "sum_cost_masch": "decimal (nullable)",
    "sum_cost_fremdfert": "decimal (nullable)",
    "sum_cost": "decimal (nullable)",
    "los_stueck": "integer (nullable)",
    "sum_min_wage": "decimal (nullable)",
    "costperone": "decimal (nullable)",
    "hoursperday": "decimal (nullable)",
    "sum_cost_ruest": "decimal (nullable)",
    "sum_cost_wage": "decimal (nullable)",
    "sum_min_setup": "decimal (nullable)",
    "sum_cost_setup": "decimal (nullable)",
    "wage_factor": "tinyint (not null)",
    "positions": [
        {
            "id": "integer (not null)",
            "pos": "smallint (nullable)",
            "cost_centre": "integer (nullable)",
            "cost_centre_name": "varchar (nullable)",
            "activity": "integer (nullable)",
            "activity_name": "varchar (not null)",
            "los_stueck": "tinyint (nullable)",
            "wagegroup": "integer (nullable)",
            "min_ruest": "decimal (nullable)",
            "min_wage": "decimal (nullable)",
            "sum_cost_wage": "decimal (nullable)",
            "min_masch": "decimal (nullable)",
            "sum_min_masch": "decimal (nullable)",
            "sum_cost_masch": "decimal (nullable)",
            "sum_pos": "decimal (nullable)",
            "sum_min": "decimal (nullable)",
            "min_cost_wage": "decimal (nullable)",
            "ap_amount": "decimal (nullable)",
            "amount": "decimal (nullable)",
            "sum_min_wage": "decimal (nullable)",
            "total_setup_min": "decimal (not null)",
            "fkt_setup_min": "decimal (not null)",
            "setup_costs": "decimal (not null)",
            "fkt_machinecost": "decimal (not null)",
            "wz_durable": "decimal (not null)",
            "wz_ek_price": "decimal (not null)",
            "wz_costs": "decimal (not null)",
            "external_work_id": "varchar (nullable)",
            "fix_price": "decimal (not null)",
            "group_no": "varchar (nullable)",
            "ff_pos": "varchar (nullable)",
            "setup_id": "varchar (nullable)",
            "staffgroup_id": "varchar (nullable)",
            "costcentregroup_id": "varchar (nullable)",
            "overlap": "decimal (not null)",
            "ab_ticket": "tinyint (not null)",
            "plan_time": "tinyint (not null)",
            "plan_min": "varchar (nullable)",
            "service_location": "varchar (not null)",
            "return_location": "varchar (not null)",
            "advance_min": "varchar (nullable)",
            "overrun_min": "varchar (nullable)",
            "estimated": "tinyint (not null)",
            "remarks": "longtext (nullable)",
            "wage_factor_type": "varchar (nullable)"
        }
    ]
}

Creates a new work schedule.

{
    "name": "Advanced Finishing Process",
    "los_stueck": 1,
    "wage_factor": 1,
    "positions": [
        {
            "pos": 10,
            "activity_name": "Sanding and Polishing",
            "min_wage": "20.00"
        }
    ]
}

Request Body Fields:

{
    "name": "varchar (not null)",
    // ... all other fields from work_schedule are available ...
    "positions": [
        {
            "activity_name": "varchar (not null)",
            // ... all other fields from work_schedule_pos are available ...
        }
    ]
}

Updates an existing work schedule.

{
    "name": "Standard Assembly Process (2025 Rev.)"
}

Request Body Fields:

{
    // Any field from the work schedule object can be included here to update it.
}

Cost Centres

Retrieves a specific cost centre.

{
    "id": 1,
    "name": "CNC Milling Dept.",
    "type": 1,
    "kalk_min_kosten": "1.850",
    "nutzungsdauer": "10.00"
}

Response Body Fields:

{
    "id": "integer (not null)",
    "name": "varchar (not null)",
    "photo_path": "varchar (nullable)",
    "kalk_std_kosten": "decimal (nullable)",
    "kalk_min_kosten": "decimal (nullable)",
    "restfertgemeinkost_std": "decimal (nullable)",
    "energiekosten_jahr": "decimal (nullable)",
    "bearbwerkzeugkost_jahr": "decimal (nullable)",
    "restfertgemeinkost_jahr": "decimal (nullable)",
    "nettolaufzeit_jahr": "decimal (nullable)",
    "grundmaschine": "decimal (nullable)",
    "zubehoer": "decimal (nullable)",
    "montage": "decimal (nullable)",
    "ausbaustufen": "decimal (nullable)",
    "investitionssumme": "decimal (nullable)",
    "betriebsstd_tag": "decimal (nullable)",
    "arbeitstage_jahr": "decimal (nullable)",
    "org_verfuegbarkeit": "decimal (nullable)",
    "wiederbeschaffungskosten": "decimal (nullable)",
    "nutzungsdauer": "decimal (nullable)",
    "kalk_abschreibung": "decimal (nullable)",
    "zinssatz": "decimal (nullable)",
    "kalk_zins": "decimal (nullable)",
    "instandhaltungskosten": "decimal (nullable)",
    "leistungsaufnahme": "decimal (nullable)",
    "kwh_kosten": "decimal (nullable)",
    "bearbwerkzeugkost_std": "decimal (nullable)",
    "raumbedarf": "decimal (nullable)",
    "raumkosten_monat": "decimal (nullable)",
    "raumkosten_jahr": "decimal (nullable)",
    "maschkost_jahr": "decimal (nullable)",
    "calc_instandhalt": "tinyint (nullable)",
    "setup_min": "decimal (nullable)",
    "setup_hour": "decimal (nullable)",
    "type": "integer (not null)",
    "to_costcentre": "integer (nullable)",
    "remove_file": "tinyint (nullable)",
    "time_model_id_id": "integer (nullable)"
}

Creates a new cost centre.

{
    "name": "Quality Assurance Lab",
    "type": 2
}

Request Body Fields:

{
    "name": "varchar (not null)",
    "type": "integer (not null)"
    // ... all other fields from cost_centre are available ...
}

Updates an existing cost centre.

{
    "kalk_min_kosten": "2.150"
}

Request Body Fields:

{
    // Any field from the cost centre object can be included here to update it.
}

General

This endpoint is used to verify the correct authentication with the API token. On success, a confirmation message is returned.

Example Response (200 OK):

{
    "status": "success",
    "message": "Authorization successful."
}

Authentication

1. Create and Manage API Tokens

Step 1: Navigate to User Management

Step 2: Access API Key Settings

Step 3: Generate a New Token

Step 4: Copy Your New Token

2. Using Your API Token

API Endpoints

Order Management

Offer Management

Work Schedules

Cost Centres

General