Creates a new work order
Request Information
URI Parameters :
None.
Body Parameters :
jobs| Name | Description | Type | Additional information |
|---|---|---|---|
| id |
Primary Key |
globally unique identifier | |
| _parent_id |
Reference to a parent job (in case of Multi Job) |
globally unique identifier | |
| _parent_job |
Embedded entity "job" for parent (multi job level) when adding/updating job |
jobs | |
| _parent_jobs_reference_back_office |
Embedded entity "job" for parent (multi job level) using ERP PK when adding/updating job |
string | |
| project_id |
Foreign key of project for this job |
globally unique identifier |
Optionally required : project_id, project_reference_back_office or project must be provided |
| project_reference_back_office |
Embedded entity "project" using ERP PK when adding/updating job |
string |
Optionally required : project_id, project_reference_back_office or project must be provided |
| project |
Embedded entity "project" when adding/updating job |
project |
Optionally required : project_id, project_reference_back_office or project must be provided |
| job_type_id |
Foreign key of job type for this job |
globally unique identifier |
Optionally required : job_type_id, job_type_code or job_type must be provided |
| job_type_code |
Embedded entity "job_type" using ERP PK when adding/updating job |
string |
Optionally required : job_type_id, job_type_code or job_type must be provided |
| job_type |
Embedded entity "job_type" when adding/updating job |
job_type |
Optionally required : job_type_id, job_type_code or job_type must be provided |
| job_priority_id |
Foreign key of job priority for this job |
globally unique identifier | |
| job_priority_code |
Foreign key of job status for this job. If you don't know the GUID, use job_type_code |
string | |
| job_priority |
Embedded entity "job_priority" when adding/updating job |
job_priority | |
| job_status_id |
Foreign key of job status for this job |
globally unique identifier |
Optionally required : job_status_id or job_status_code must be provided |
| job_status_code |
Foreign key of job status using code. Use "Canceled,ToBePlanned, Waiting, Pooling, Suggested, Activated or Open" If Status=Suggested AND suggested_user filled AND suggested_date_start filled THEN a job_planning will be added |
string |
Optionally required : job_status_id or job_status_code must be provided |
| db_address_id |
Foreign key of db_address if job is not on a mobile equipment.Must be the address_id of the location or the equipment |
globally unique identifier | |
| contact_id |
Foreign key of contact if the main contact of the job is different than the one of the project |
globally unique identifier | |
| requested_by_company_id |
Foreign key of company if a specific company makes the request for this job |
globally unique identifier | |
| requested_by_contact_id |
Foreign key of contact to specify why contact of the requested_company_id makes the request |
globally unique identifier | |
| reference_back_office |
The Id/Ref of the back office for this job. Used by Embedded entity |
string |
Max length: 50 |
| name |
Name of the Job |
string |
Required Max length: 255 |
| description |
Description of the job |
string |
Max length: 4000 |
| working_sequence |
In case of mutli job, they will be ordered by this sequence |
integer | |
| internal_memo |
Internal field for communication between BackOffice/Planners/Technicians |
string | |
| prejob_information |
Information usefull for the technician before start (Call the customer,...) |
string | |
| estimated_time |
Estimation of the time needed (in minute). Will be used for planning and statistic |
integer | |
| earliest_date_plannable |
Use this field if there is a minimum date for the planning (Not Before) |
date | |
| due_date |
Deadline of Max date for the planning (Not After) |
date | |
| date_create |
Creation date+time |
date | |
| date_update |
Update date+time |
date | |
| date_closed |
Date+time job goes to completed |
date | |
| suggested_user_id |
Foreign key of user if there is a suggested user (used for planning) If Status=Suggested AND suggested_user filled AND suggested_date_start filled THEN a job_planning will be added |
globally unique identifier | |
| suggested_user_code |
Embedded entity "suggested user" using ERP PK when adding/updating job |
string | |
| suggested_user |
Embedded entity "sugessted user" when adding/updating job |
user | |
| suggested_date_start |
Suggested date+time start (used for planning) If Status=Suggested AND suggested_user filled AND suggested_date_start filled THEN a job_planning will be added |
date | |
| skill_id |
Foreign key of skill if the job requires a specific skill (used for planning) |
globally unique identifier | |
| skill_code |
Embedded entity "skill" using ERP PK when adding/updating job |
string | |
| skill |
Embedded entity "skill" when adding/updating job |
skill | |
| customer_reference |
Reference of this job for the customer |
string |
Max length: 50 |
| approval_responsible_user_id |
In case of multi user job, foreign key of user that is the "WO Leader" |
globally unique identifier | |
| date_reported_by_company |
Date+time when company reported the problem |
date | |
| id2 |
Internal ID (numeric). Will be used if reference_back_office is empty |
integer | |
| company_id |
This field will be filled automatically based on the project_id |
globally unique identifier | |
| company_code |
This field will be filled automatically based on the project_id |
string | |
| db_address_name |
When mobile equipment, the address to use |
string |
Max length: 100 |
| db_address_street |
When mobile equipment, the address to use and this field is mandatory |
string |
Max length: 50 |
| db_address_street2 |
It is sub street |
string |
Max length: 50 |
| db_address_street_number |
When mobile equipment, the address to use |
string |
Max length: 50 |
| db_address_city |
When mobile equipment, the address to use and this field is mandatory |
string |
Max length: 50 |
| db_address_zip |
When mobile equipment, the address to use and this field is mandatory |
string |
Max length: 50 |
| db_address_db_country_id |
When mobile equipment, the address to use |
globally unique identifier | |
| db_address_db_country_code |
When mobile equipment, the address to use |
string | |
| db_address_phone |
When mobile equipment, the address to use |
string |
Max length: 50 |
| db_address_email |
When mobile equipment, the address to use |
string |
Max length: 250 |
| db_address_latitude_decimal |
Latitude |
decimal number | |
| db_address_longitude_decimal |
Latitude |
decimal number | |
| estimated_quantity_remark |
Description of the parts your technician should use or pick up |
string |
Max length: 4000 |
| modified_dateutc |
Readonly system field managed by database, filled with GetUtcDate when adding,updating |
date |
Request Formats :
application/json, text/json
{
"id": "2e5c4f65-dbd0-4d34-9485-93985150ddd5",
"_parent_id": "758a7475-bbee-4424-8dc1-0eb123dfedbb",
"_parent_jobs_reference_back_office": "sample string 3",
"project_id": "b00f5afe-867c-42bb-9d4e-227bb38d957d",
"project_reference_back_office": "sample string 5",
"project": {
"id": "d2af9f08-7c65-4aa3-91b6-528958d47538",
"_parent_id": "f5c6083a-22d9-4042-914c-d40c41a4ac38",
"root_parent_id": "b909adfa-099b-41b4-a4bd-5c7737c4c8d1",
"_parent_reference_back_office": "sample string 4",
"equipment_family_id": "90f08cdd-cc09-4617-b3d7-5eec0d90eadf",
"equipment_family_code": "sample string 6",
"equipment_family": {
"id": "5ea1000d-5bb7-4402-b570-67d66a30d65f",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"_parent_id": "fe5f7346-2f93-44a1-be48-53e56c647d1d",
"_parent_code": "sample string 6",
"sales_organization_id": "3b5449c6-c1fb-46a9-8980-7b9a60638d0e",
"sales_organization_code": "sample string 8",
"sales_organization": {
"id": "efb2a27a-c570-402c-9047-674abc7af042",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "f8c40086-197f-4c65-a527-938e0db00692",
"db_currency_id": "c737c825-ab43-4e89-bc45-57dd98de97b5",
"db_language_id": "77214063-2164-4253-8334-6df4de69fb5c",
"accountancy_code": "sample string 8",
"archived": true,
"default_unit_of_measure_system_type": "sample string 10",
"street": "sample string 11",
"street2": "sample string 12",
"street_number": "sample string 13",
"zip": "sample string 14",
"city": "sample string 15",
"email": "sample string 16",
"phone": "sample string 17",
"fax": "sample string 18",
"url": "sample string 19",
"vat_reg_code": "sample string 20",
"modified_dateutc": "2026-01-03T04:35:00.17918+00:00"
},
"modified_dateutc": "2026-01-03T04:35:00.17918+00:00"
},
"equipment_model_id": "5a9d8d38-e4aa-421c-97cf-b34a1dd27d7c",
"equipment_model_code": "sample string 8",
"equipment_model": {
"id": "b11d0c49-419a-4908-bcc1-ea8b0fb698f7",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"equipment_brand_id": "3ac81d72-e9b7-4229-929d-abe12bdd2ffc",
"equipment_brand_code": "sample string 6",
"equipment_brand": {
"id": "ca671592-6efd-4e2e-bc4a-0095e42b0d52",
"name": "sample string 2",
"code": "sample string 3",
"sales_organization_id": "b69dd1dc-84cb-4db7-8b5b-17254aaf9c4a",
"sales_organization_code": "sample string 5",
"sales_organization": {
"id": "efb2a27a-c570-402c-9047-674abc7af042",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "f8c40086-197f-4c65-a527-938e0db00692",
"db_currency_id": "c737c825-ab43-4e89-bc45-57dd98de97b5",
"db_language_id": "77214063-2164-4253-8334-6df4de69fb5c",
"accountancy_code": "sample string 8",
"archived": true,
"default_unit_of_measure_system_type": "sample string 10",
"street": "sample string 11",
"street2": "sample string 12",
"street_number": "sample string 13",
"zip": "sample string 14",
"city": "sample string 15",
"email": "sample string 16",
"phone": "sample string 17",
"fax": "sample string 18",
"url": "sample string 19",
"vat_reg_code": "sample string 20",
"modified_dateutc": "2026-01-03T04:35:00.17918+00:00"
},
"modified_dateutc": "2026-01-03T04:35:00.17918+00:00"
},
"equipment_family_id": "35084c39-beed-4400-95a5-7ef0e5e34537",
"equipment_family_code": "sample string 8",
"equipment_family": {
"id": "5ea1000d-5bb7-4402-b570-67d66a30d65f",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"_parent_id": "fe5f7346-2f93-44a1-be48-53e56c647d1d",
"_parent_code": "sample string 6",
"sales_organization_id": "3b5449c6-c1fb-46a9-8980-7b9a60638d0e",
"sales_organization_code": "sample string 8",
"sales_organization": {
"id": "efb2a27a-c570-402c-9047-674abc7af042",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "f8c40086-197f-4c65-a527-938e0db00692",
"db_currency_id": "c737c825-ab43-4e89-bc45-57dd98de97b5",
"db_language_id": "77214063-2164-4253-8334-6df4de69fb5c",
"accountancy_code": "sample string 8",
"archived": true,
"default_unit_of_measure_system_type": "sample string 10",
"street": "sample string 11",
"street2": "sample string 12",
"street_number": "sample string 13",
"zip": "sample string 14",
"city": "sample string 15",
"email": "sample string 16",
"phone": "sample string 17",
"fax": "sample string 18",
"url": "sample string 19",
"vat_reg_code": "sample string 20",
"modified_dateutc": "2026-01-03T04:35:00.17918+00:00"
},
"modified_dateutc": "2026-01-03T04:35:00.17918+00:00"
},
"date_in_production_since": "2026-01-03T04:35:00.17918+00:00",
"date_out_of_production_since": "2026-01-03T04:35:00.17918+00:00",
"date_end_support": "2026-01-03T04:35:00.17918+00:00",
"sales_organization_id": "a20ca858-56bf-4c14-ada7-8e71aee5fe78",
"sales_organization_code": "sample string 13",
"sales_organization": {
"id": "efb2a27a-c570-402c-9047-674abc7af042",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "f8c40086-197f-4c65-a527-938e0db00692",
"db_currency_id": "c737c825-ab43-4e89-bc45-57dd98de97b5",
"db_language_id": "77214063-2164-4253-8334-6df4de69fb5c",
"accountancy_code": "sample string 8",
"archived": true,
"default_unit_of_measure_system_type": "sample string 10",
"street": "sample string 11",
"street2": "sample string 12",
"street_number": "sample string 13",
"zip": "sample string 14",
"city": "sample string 15",
"email": "sample string 16",
"phone": "sample string 17",
"fax": "sample string 18",
"url": "sample string 19",
"vat_reg_code": "sample string 20",
"modified_dateutc": "2026-01-03T04:35:00.17918+00:00"
},
"replacement_period_nb_months": 14,
"warranty_period_nb_months": 15,
"translations": [
{
"field_name": "sample string 1",
"language_code": "sample string 2",
"value_translated": "sample string 3"
},
{
"field_name": "sample string 1",
"language_code": "sample string 2",
"value_translated": "sample string 3"
}
],
"modified_dateutc": "2026-01-03T04:35:00.17918+00:00"
},
"project_status_id": "b3f51b10-434c-41d2-ac9e-0fe765a7accb",
"project_status_code": "sample string 10",
"project_status": {
"id": "f31e5cd0-6c4c-4675-b5d7-90cb7dafd3c7",
"name": "sample string 2",
"is_default": true,
"is_closed": true,
"sales_organization_id": "95c016b0-f817-42fc-9975-f3c8ca01ae9b",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "efb2a27a-c570-402c-9047-674abc7af042",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "f8c40086-197f-4c65-a527-938e0db00692",
"db_currency_id": "c737c825-ab43-4e89-bc45-57dd98de97b5",
"db_language_id": "77214063-2164-4253-8334-6df4de69fb5c",
"accountancy_code": "sample string 8",
"archived": true,
"default_unit_of_measure_system_type": "sample string 10",
"street": "sample string 11",
"street2": "sample string 12",
"street_number": "sample string 13",
"zip": "sample string 14",
"city": "sample string 15",
"email": "sample string 16",
"phone": "sample string 17",
"fax": "sample string 18",
"url": "sample string 19",
"vat_reg_code": "sample string 20",
"modified_dateutc": "2026-01-03T04:35:00.17918+00:00"
},
"code": "sample string 7",
"modified_dateutc": "2026-01-03T04:35:00.17918+00:00"
},
"company_id": "37ba9bdb-0309-4dc3-8f38-2deafd9922f0",
"company_code": "sample string 12",
"db_address_id": "e5114cef-54a3-473b-962c-95fed917931c",
"db_address_code": "sample string 14",
"location": "sample string 15",
"contact_id": "075ebdea-ca34-445d-b1f4-7a2934ad3ee5",
"contact_reference_back_office": "sample string 17",
"owner_user_id": "3109b9e9-b21a-47a1-8110-24a1a5accc79",
"name": "sample string 19",
"description": "sample string 20",
"reference_back_office": "sample string 21",
"serial_number": "sample string 22",
"barcode": "sample string 23",
"date_start_production": "2026-01-03T04:35:00.17918+00:00",
"date_create": "2026-01-03T04:35:00.17918+00:00",
"date_update": "2026-01-03T04:35:00.17918+00:00",
"updated_by_user_id": "e080d6e5-d319-4884-8ac0-2d2b4cd582ea",
"customer_reference": "sample string 28",
"warranty_date_until": "2026-01-03T04:35:00.17918+00:00",
"last_standard_result_score_1": "sample string 30",
"last_standard_result_score_2": "sample string 31",
"target_standard_result_score_1": "sample string 32",
"target_standard_result_score_2": "sample string 33",
"date_built": "2026-01-03T00:00:00+00:00",
"shutdown_consequence": "sample string 35",
"id2": 36,
"nb_open_jobs": 37,
"date_next_job": "2026-01-03T04:35:00.17918+00:00",
"date_last_job": "2026-01-03T04:35:00.17918+00:00",
"nb_jobs_planned": 40,
"nb_jobs_tobeplanned": 41,
"nb_jobs_waitingfurtheraction": 42,
"back_office_timestamp": "2026-01-03T04:35:00.17918+00:00",
"modified_dateutc": "2026-01-03T04:35:00.17918+00:00",
"is_mobile_installation": true
},
"job_type_id": "fdedf153-a85b-40d0-a043-991d10e8e4ad",
"job_type_code": "sample string 7",
"job_type": {
"id": "f5b77ee4-2bad-4ce7-81f1-7133787fce65",
"name": "sample string 2",
"sales_organization_id": "2c6b0d62-d707-4936-adfc-cc0bfba8f99f",
"description": "sample string 4",
"is_default": true,
"modified_dateutc": "2026-01-03T04:35:00.17918+00:00",
"code": "sample string 7"
},
"job_priority_id": "b3449aa6-38d6-42d7-bb3f-f63707081d90",
"job_priority_code": "sample string 9",
"job_priority": {
"id": "71a38224-f93c-4285-b62f-71cfab32f594",
"name": "sample string 2",
"is_default": true,
"sequence": 4,
"sales_organization_id": "22eba2e7-2a72-4f42-95cd-15cc9d9e8ee4",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "efb2a27a-c570-402c-9047-674abc7af042",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "f8c40086-197f-4c65-a527-938e0db00692",
"db_currency_id": "c737c825-ab43-4e89-bc45-57dd98de97b5",
"db_language_id": "77214063-2164-4253-8334-6df4de69fb5c",
"accountancy_code": "sample string 8",
"archived": true,
"default_unit_of_measure_system_type": "sample string 10",
"street": "sample string 11",
"street2": "sample string 12",
"street_number": "sample string 13",
"zip": "sample string 14",
"city": "sample string 15",
"email": "sample string 16",
"phone": "sample string 17",
"fax": "sample string 18",
"url": "sample string 19",
"vat_reg_code": "sample string 20",
"modified_dateutc": "2026-01-03T04:35:00.17918+00:00"
},
"code": "sample string 7",
"modified_dateutc": "2026-01-03T04:35:00.17918+00:00"
},
"job_status_id": "9d5ad701-5d05-41bf-9c56-f3c31c4e55c8",
"job_status_code": "sample string 11",
"db_address_id": "9cedb322-7d2f-4fc9-82d5-e6f40a9c2638",
"contact_id": "e0cd66ce-378b-4fad-9a58-793f3f2b0524",
"requested_by_company_id": "25cd96c5-e5fb-433b-b9a1-f97b4843bcee",
"requested_by_contact_id": "93309e3b-8a74-444c-b5b3-717afe9d8c21",
"reference_back_office": "sample string 16",
"name": "sample string 17",
"description": "sample string 18",
"working_sequence": 19,
"internal_memo": "sample string 20",
"prejob_information": "sample string 21",
"estimated_time": 22,
"earliest_date_plannable": "2026-01-03T04:35:00.17918+00:00",
"due_date": "2026-01-03T04:35:00.17918+00:00",
"date_create": "2026-01-03T04:35:00.17918+00:00",
"date_update": "2026-01-03T04:35:00.17918+00:00",
"date_closed": "2026-01-03T04:35:00.17918+00:00",
"suggested_user_id": "c5149350-ae61-4c59-a5af-b3b2c4c6f5e7",
"suggested_user_code": "sample string 29",
"suggested_user": {
"id": "9d52ddb7-1467-4553-80ed-c47126f09822",
"db_language_id": "9bc45719-1774-444f-8608-595c86044384",
"username": "sample string 3",
"firstname": "sample string 4",
"lastname": "sample string 5",
"code": "sample string 6",
"archived": true,
"disabled": true,
"emergency_contact": "sample string 9",
"bankaccount": "sample string 10",
"social_security": "sample string 11",
"place_of_birth": "sample string 12",
"nationality": "sample string 13",
"functions": "sample string 14",
"birthdate": "2026-01-03T04:35:00.17918+00:00",
"skype": "sample string 16",
"notes": "sample string 17",
"sales_organization_id": "555f11bb-406d-4a86-a67a-275bde140a4f",
"sales_organization": {
"id": "efb2a27a-c570-402c-9047-674abc7af042",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "f8c40086-197f-4c65-a527-938e0db00692",
"db_currency_id": "c737c825-ab43-4e89-bc45-57dd98de97b5",
"db_language_id": "77214063-2164-4253-8334-6df4de69fb5c",
"accountancy_code": "sample string 8",
"archived": true,
"default_unit_of_measure_system_type": "sample string 10",
"street": "sample string 11",
"street2": "sample string 12",
"street_number": "sample string 13",
"zip": "sample string 14",
"city": "sample string 15",
"email": "sample string 16",
"phone": "sample string 17",
"fax": "sample string 18",
"url": "sample string 19",
"vat_reg_code": "sample string 20",
"modified_dateutc": "2026-01-03T04:35:00.17918+00:00"
},
"sales_organization_code": "sample string 19",
"is_team_leader": true,
"team_leader_user_id": "5ccbd58f-934b-475d-8bee-7b32b6973983",
"email": "sample string 22",
"phone": "sample string 23",
"fax": "sample string 24",
"mobile": "sample string 25",
"private_email": "sample string 26",
"private_phone": "sample string 27",
"private_fax": "sample string 28",
"private_mobile": "sample string 29",
"private_street": "sample string 30",
"private_street_number": "sample string 31",
"private_city": "sample string 32",
"private_zip": "sample string 33",
"private_db_country_id": "51c3e258-aadc-4e65-944f-033d253c062f",
"private_db_country_code": "sample string 35",
"modified_dateutc": "2026-01-03T04:35:00.17918+00:00",
"allow_hero_app": true,
"allow_sales_app": true,
"allow_service_app": true,
"user_group_id": "41a8380d-26c4-4820-8581-b8d4009fd874"
},
"suggested_date_start": "2026-01-03T04:35:00.17918+00:00",
"skill_id": "19e58e27-e039-4003-8394-479e865d876a",
"skill_code": "sample string 32",
"skill": {
"id": "6cded2b5-f03a-4812-8bdc-2227d7142309",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"sales_organization_id": "2bf28f7b-3966-4479-b23d-d565bcdcbb90",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "efb2a27a-c570-402c-9047-674abc7af042",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "f8c40086-197f-4c65-a527-938e0db00692",
"db_currency_id": "c737c825-ab43-4e89-bc45-57dd98de97b5",
"db_language_id": "77214063-2164-4253-8334-6df4de69fb5c",
"accountancy_code": "sample string 8",
"archived": true,
"default_unit_of_measure_system_type": "sample string 10",
"street": "sample string 11",
"street2": "sample string 12",
"street_number": "sample string 13",
"zip": "sample string 14",
"city": "sample string 15",
"email": "sample string 16",
"phone": "sample string 17",
"fax": "sample string 18",
"url": "sample string 19",
"vat_reg_code": "sample string 20",
"modified_dateutc": "2026-01-03T04:35:00.17918+00:00"
},
"modified_dateutc": "2026-01-03T04:35:00.17918+00:00"
},
"customer_reference": "sample string 33",
"approval_responsible_user_id": "a1662894-d6b9-4d12-befe-248e00634854",
"date_reported_by_company": "2026-01-03T04:35:00.17918+00:00",
"id2": 36,
"company_id": "040381dc-5a06-4af2-b1fc-fe7cf130012e",
"company_code": "sample string 38",
"db_address_name": "sample string 39",
"db_address_street": "sample string 40",
"db_address_street2": "sample string 41",
"db_address_street_number": "sample string 42",
"db_address_city": "sample string 43",
"db_address_zip": "sample string 44",
"db_address_db_country_id": "844a6967-a485-4df1-ad20-0a52ae024603",
"db_address_db_country_code": "sample string 46",
"db_address_phone": "sample string 47",
"db_address_email": "sample string 48",
"db_address_latitude_decimal": 49.0,
"db_address_longitude_decimal": 50.0,
"estimated_quantity_remark": "sample string 51",
"modified_dateutc": "2026-01-03T04:35:00.17918+00:00"
}
Response Information
Resource Description :
IHttpActionResultNone.
Response Formats
application/json, text/json
Sample not available.