Creates a new location object
Request Information
URI Parameters :
None.
Body Parameters :
location| Name | Description | Type | Additional information |
|---|---|---|---|
| id | globally unique identifier |
Required |
|
| _parent_id |
Reference to a parent location |
globally unique identifier | |
| _parent_reference_back_office |
Embedded entity "location" for parent location using ERP PK when adding/updating location |
string | |
| _parent_location |
Embedded entity "location" for parent location when adding/updating location |
location | |
| project_status_id |
Foreign key to project_status_id |
globally unique identifier | |
| company_id |
The company owner of this location |
globally unique identifier |
Optionally required : company_id, company_code or company must be provided |
| company_code |
Embedded entity "company" using ERP PK when adding/updating location |
string |
Optionally required : company_id, company_code or company must be provided |
| company |
Embedded entity "company" when adding/updating location |
company |
Optionally required : company_id, company_code or company must be provided |
| name |
Name of the location |
string |
Required Max length: 50 |
| extra_information |
extra_information |
string |
Max length: 255 |
| reference_back_office |
The Id/Ref of the back office for this location. Used by Embedded entity |
string |
Max length: 255 |
| street |
Street |
string |
Max length: 100 |
| street_number |
Street number. |
string |
Max length: 50 |
| zip |
Zip code |
string |
Max length: 50 |
| city |
City |
string |
Max length: 50 |
| phone |
Phone number |
string |
Max length: 50 |
|
Email address |
string |
Max length: 250 |
|
| db_country_id |
Foreign key to table Country |
globally unique identifier | |
| db_country_code |
CountryCode entity using international code when adding/updating company |
string | |
| street2 |
Additional information on the address not part of the postal address |
string |
Max length: 50 |
| latitude_decimal |
Decimal coordonate for the latitude. (-1;-1) means invalid and (0;0) means not already geo-encoded |
decimal number | |
| longitude_decimal |
Decimal coordonate for the longitude. (-1;-1) means invalid and (0;0) means not already geo-encoded |
decimal number | |
| contact_id |
Foreign key of contact for this location |
globally unique identifier | |
| contact_reference_back_office |
Foreign key of contact for this location. If you don't know the GUID, use contact_reference_back_office |
string | |
| contact |
Embedded entity "contact" when adding/updating location |
contact | |
| modified_dateutc |
Readonly system field managed by database, filled with GetUtcDate when adding,updating |
date | |
| id2 |
Internal ID (numeric). Will be used if reference_back_office is empty |
integer |
Request Formats :
application/json, text/json
Sample:
{
"id": "e074c78a-1a01-4527-a431-f5da74c74a5e",
"_parent_id": "0b464758-4909-43a7-ad73-6e4eb43eb13a",
"_parent_reference_back_office": "sample string 3",
"project_status_id": "1fcb37b6-e168-470c-afa4-447dbd160118",
"company_id": "3a49751a-f573-4f7a-acc7-1452c06f08d0",
"company_code": "sample string 6",
"name": "sample string 7",
"extra_information": "sample string 8",
"reference_back_office": "sample string 9",
"street": "sample string 10",
"street_number": "sample string 11",
"zip": "sample string 12",
"city": "sample string 13",
"phone": "sample string 14",
"email": "sample string 15",
"db_country_id": "a0b27bb2-b793-4918-ab81-c43dd0502f47",
"db_country_code": "sample string 17",
"street2": "sample string 18",
"latitude_decimal": 1.0,
"longitude_decimal": 1.0,
"contact_id": "f3b794da-f24a-4cba-beda-9fdd26567598",
"contact_reference_back_office": "sample string 20",
"contact": {
"id": "99129494-4c4a-43d4-aa9a-5f0da7d4d77a",
"firstname": "sample string 2",
"lastname": "sample string 3",
"company_id": "c8218229-1ef0-4d2e-a41f-c9fa312a8779",
"company_code": "sample string 5",
"company": {
"id": "518c9a33-87ab-4b4e-8d7c-bf8a315fdb36",
"is_client": true,
"is_supplier": true,
"archived": true,
"name": "sample string 5",
"notes": "sample string 6",
"create_date": "2026-04-08T01:17:12.1800738+00:00",
"sales_territory_id": "1af03738-d0cb-4541-9b01-62fd6de887ee",
"sales_territory_code": "sample string 9",
"sales_territory": {
"id": "084b8975-0d31-429f-8ff5-0996f6e9f8b4",
"code": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "78407d13-bc40-4fa6-9fed-ea58df826610",
"sales_organization_code": "sample string 5",
"sales_organization": {
"id": "5f1491e1-c1dc-475b-b412-358044882425",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "fa1c7d46-37f5-4f2d-83dc-7ffc7906c91a",
"db_currency_id": "4384ab10-add2-419e-a9ee-2180c9b79547",
"db_language_id": "71246788-7977-46a6-b094-f01c42431576",
"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-04-08T01:17:12.1800738+00:00"
},
"modified_dateutc": "2026-04-08T01:17:12.1800738+00:00"
},
"marketing_segment_id": "d5cfe0d7-7951-414b-bae9-30839026d94b",
"marketing_segment_code": "sample string 11",
"sales_organization_id": "a7a82d35-ab0b-4120-a83e-feb3ae9f3e3b",
"sales_organization_code": "sample string 13",
"company_sales_status_code": "sample string 14",
"vat_reg_code": "sample string 15",
"is_working_address": true,
"parent_id": "6170f185-5766-4310-9c6b-4c40b329ed19",
"parent_company_code": "sample string 18",
"phone": "sample string 19",
"fax": "sample string 20",
"url": "sample string 21",
"email": "sample string 22",
"street": "sample string 23",
"street_number": "sample string 24",
"city": "sample string 25",
"zip": "sample string 26",
"db_country_id": "ddaa818f-2d35-42df-a07b-41ba6fb69fe2",
"db_country_code": "sample string 28",
"feelist_id": "2c6aaea4-6acc-4958-8d49-6d2844eb8851",
"feelist_reference_back_office": "sample string 30",
"feelist": {
"id": "329f46a7-76e5-42e8-8c5b-c5509367e4b0",
"name": "sample string 2",
"description": "sample string 3",
"is_default": true,
"default_price": 1.0,
"sales_organization_id": "4c19020f-4f16-4c79-916f-8e0f69263070",
"sales_organization_code": "sample string 6",
"reference_back_office": "sample string 7",
"modified_dateutc": "2026-04-08T01:17:12.1956979+00:00",
"db_currency_id": "d9c73833-f550-4ae8-b6e9-a9f0f60abd47",
"db_currency_code": "sample string 10"
},
"company_type_id": "ca8b2f15-8699-47d2-9b98-cb0f077fa550",
"company_type_name": "sample string 32",
"company_type": {
"id": "50045829-cfff-4180-817a-ce8162b7518f",
"name": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "d6d1f11e-2483-48a2-87f2-0d817378dd43",
"sales_organization_code": "sample string 5"
},
"db_language_id": "0473a308-b7ba-4d1f-8ed3-b4fb17152dd1",
"db_language_code": "sample string 34",
"code": "sample string 35",
"article_price_label_id": "be351125-5290-424f-b28c-ea6787255416",
"article_price_label_code": "sample string 37",
"db_payment_method_id": "e9e50bfb-34dc-4605-9d68-08d68f39ef8c",
"db_payment_method_reference_back_office": "sample string 39",
"db_payment_methods": {
"id": "f232bfcf-b29a-4bec-9c03-dce46a1a7080",
"name": "sample string 2",
"description": "sample string 3",
"reference_back_office": "sample string 4",
"activated": true,
"modified_dateutc": "2026-04-08T01:17:12.1956979+00:00"
},
"company_sector_id": "a5be178a-4f40-4757-8c9f-4593db8f2588",
"company_sector_code": "sample string 41",
"is_lead": true,
"is_subcontractor": true,
"latitude": 1.0,
"longitude": 1.0,
"street2": "sample string 44",
"bic_code": "sample string 45",
"specialities": "sample string 46",
"register_number": "sample string 47",
"register_city": "sample string 48",
"bankaccount": "sample string 49",
"mobile": "sample string 50",
"service_manager_user_id": "cf8796a3-bb58-4b05-aeb2-5299d7ae629d",
"service_manager_user_code": "sample string 52",
"finance_manager_user_id": "e79b32f6-f2ad-46b1-934e-3bab5fdf2184",
"finance_manager_user_code": "sample string 54",
"account_manager_user_id": "7b502d17-389c-4230-b042-15fc83fcc4ae",
"account_manager_user_code": "sample string 56",
"company_status_id": "7b91e924-d8c3-479b-ac70-6bb82a1171b3",
"invoice_email_to": "sample string 58",
"modified_dateutc": "2026-04-08T01:17:12.1956979+00:00",
"id2": 60
},
"db_language_id": "e0b7e318-aaae-4a76-9efe-f6ff844c0f64",
"db_language_code": "sample string 7",
"db_title_id": "b4255a14-7e2c-444d-b1d3-f59095be7bc0",
"archived": true,
"functions": "sample string 10",
"e_login": "sample string 11",
"e_password": "sample string 12",
"notes": "sample string 13",
"birthdate": "2026-04-08T01:17:12.1956979+00:00",
"create_date": "2026-04-08T01:17:12.1956979+00:00",
"phone": "sample string 16",
"mobile": "sample string 17",
"email": "sample string 18",
"skype": "sample string 19",
"private_phone": "sample string 20",
"private_mobile": "sample string 21",
"private_email": "sample string 22",
"reference_back_office": "sample string 23",
"modified_dateutc": "2026-04-08T01:17:12.1956979+00:00"
},
"modified_dateutc": "2026-04-08T01:17:12.1956979+00:00",
"id2": 22
}
Response Information
Resource Description :
location| Name | Description | Type | Additional information |
|---|---|---|---|
| id | globally unique identifier |
Required |
|
| _parent_id |
Reference to a parent location |
globally unique identifier | |
| _parent_reference_back_office |
Embedded entity "location" for parent location using ERP PK when adding/updating location |
string | |
| _parent_location |
Embedded entity "location" for parent location when adding/updating location |
location | |
| project_status_id |
Foreign key to project_status_id |
globally unique identifier | |
| company_id |
The company owner of this location |
globally unique identifier |
Optionally required : company_id, company_code or company must be provided |
| company_code |
Embedded entity "company" using ERP PK when adding/updating location |
string |
Optionally required : company_id, company_code or company must be provided |
| company |
Embedded entity "company" when adding/updating location |
company |
Optionally required : company_id, company_code or company must be provided |
| name |
Name of the location |
string |
Required Max length: 50 |
| extra_information |
extra_information |
string |
Max length: 255 |
| reference_back_office |
The Id/Ref of the back office for this location. Used by Embedded entity |
string |
Max length: 255 |
| street |
Street |
string |
Max length: 100 |
| street_number |
Street number. |
string |
Max length: 50 |
| zip |
Zip code |
string |
Max length: 50 |
| city |
City |
string |
Max length: 50 |
| phone |
Phone number |
string |
Max length: 50 |
|
Email address |
string |
Max length: 250 |
|
| db_country_id |
Foreign key to table Country |
globally unique identifier | |
| db_country_code |
CountryCode entity using international code when adding/updating company |
string | |
| street2 |
Additional information on the address not part of the postal address |
string |
Max length: 50 |
| latitude_decimal |
Decimal coordonate for the latitude. (-1;-1) means invalid and (0;0) means not already geo-encoded |
decimal number | |
| longitude_decimal |
Decimal coordonate for the longitude. (-1;-1) means invalid and (0;0) means not already geo-encoded |
decimal number | |
| contact_id |
Foreign key of contact for this location |
globally unique identifier | |
| contact_reference_back_office |
Foreign key of contact for this location. If you don't know the GUID, use contact_reference_back_office |
string | |
| contact |
Embedded entity "contact" when adding/updating location |
contact | |
| modified_dateutc |
Readonly system field managed by database, filled with GetUtcDate when adding,updating |
date | |
| id2 |
Internal ID (numeric). Will be used if reference_back_office is empty |
integer |
Response Formats
application/json, text/json
Sample:
{
"id": "5e0e9027-2215-46e6-a0ca-7426c528fd4c",
"_parent_id": "e4cbb473-49da-4a9e-810b-7e4c9af96254",
"_parent_reference_back_office": "sample string 3",
"project_status_id": "1edc7ce7-4e1d-4bed-b3a0-26a75310d559",
"company_id": "085df908-c89e-473e-8339-b73739d05252",
"company_code": "sample string 6",
"name": "sample string 7",
"extra_information": "sample string 8",
"reference_back_office": "sample string 9",
"street": "sample string 10",
"street_number": "sample string 11",
"zip": "sample string 12",
"city": "sample string 13",
"phone": "sample string 14",
"email": "sample string 15",
"db_country_id": "03fa2940-127d-455e-a0d8-6e83bb6ddf5d",
"db_country_code": "sample string 17",
"street2": "sample string 18",
"latitude_decimal": 1.0,
"longitude_decimal": 1.0,
"contact_id": "f30ae6f3-2860-43be-9333-270c5d2a26b5",
"contact_reference_back_office": "sample string 20",
"contact": {
"id": "0b6812dd-2a55-4277-b160-b0ed63ce6605",
"firstname": "sample string 2",
"lastname": "sample string 3",
"company_id": "d3274691-fc13-4ea3-8201-3fb46481c410",
"company_code": "sample string 5",
"company": {
"id": "748e7937-b713-4ddc-a1e0-8e00d26949ee",
"is_client": true,
"is_supplier": true,
"archived": true,
"name": "sample string 5",
"notes": "sample string 6",
"create_date": "2026-04-08T01:17:12.1956979+00:00",
"sales_territory_id": "7835ffc3-c6b8-4199-84a0-d508c24732fd",
"sales_territory_code": "sample string 9",
"sales_territory": {
"id": "e02ae73d-9e5f-4e02-b5b1-98dc95248a07",
"code": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "05180890-5199-4ba7-8db0-8f05bf26ea85",
"sales_organization_code": "sample string 5",
"sales_organization": {
"id": "a9a459b9-480d-4590-ad08-bc543591349a",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "04850855-7b38-42bd-a984-27b26fa1eb23",
"db_currency_id": "127ab5d2-04ba-441e-a6bb-60b02a5bbb8f",
"db_language_id": "7ef13cc1-b4d5-4f13-bd5a-92a2ff841bf6",
"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-04-08T01:17:12.1956979+00:00"
},
"modified_dateutc": "2026-04-08T01:17:12.1956979+00:00"
},
"marketing_segment_id": "954977ba-4204-4697-b391-c307690bbc26",
"marketing_segment_code": "sample string 11",
"sales_organization_id": "333a3b8b-c48f-4162-b388-2477f61db387",
"sales_organization_code": "sample string 13",
"company_sales_status_code": "sample string 14",
"vat_reg_code": "sample string 15",
"is_working_address": true,
"parent_id": "57ad7f13-fd28-44e9-bad0-5418ba876481",
"parent_company_code": "sample string 18",
"phone": "sample string 19",
"fax": "sample string 20",
"url": "sample string 21",
"email": "sample string 22",
"street": "sample string 23",
"street_number": "sample string 24",
"city": "sample string 25",
"zip": "sample string 26",
"db_country_id": "4d92f500-411a-4587-af5a-4f50520b7051",
"db_country_code": "sample string 28",
"feelist_id": "a4f6f234-0c41-4325-b6c8-e5d57b6ab466",
"feelist_reference_back_office": "sample string 30",
"feelist": {
"id": "15c53d77-b82f-4a8b-9333-e564a377ac80",
"name": "sample string 2",
"description": "sample string 3",
"is_default": true,
"default_price": 1.0,
"sales_organization_id": "d1edea96-6f62-481f-8520-dc346529876a",
"sales_organization_code": "sample string 6",
"reference_back_office": "sample string 7",
"modified_dateutc": "2026-04-08T01:17:12.1956979+00:00",
"db_currency_id": "9517e178-5b35-42b7-b198-a55704fc3415",
"db_currency_code": "sample string 10"
},
"company_type_id": "0a8220a9-588c-4ad8-9792-3ead117d96e3",
"company_type_name": "sample string 32",
"company_type": {
"id": "2e2c8acc-6379-4f99-97de-cc361e5eb65c",
"name": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "44e666fe-e374-4263-8fed-9a321f36fd00",
"sales_organization_code": "sample string 5"
},
"db_language_id": "8f97414f-00f4-44f3-84bd-9d98b81a1946",
"db_language_code": "sample string 34",
"code": "sample string 35",
"article_price_label_id": "e3683635-d3cf-40e8-8848-184bb5577434",
"article_price_label_code": "sample string 37",
"db_payment_method_id": "0bdb198c-29b5-4360-8207-7af9a4d27f11",
"db_payment_method_reference_back_office": "sample string 39",
"db_payment_methods": {
"id": "34b3fb76-56a9-4a18-8af8-781e674968ed",
"name": "sample string 2",
"description": "sample string 3",
"reference_back_office": "sample string 4",
"activated": true,
"modified_dateutc": "2026-04-08T01:17:12.1956979+00:00"
},
"company_sector_id": "4ab27d96-18b8-4bd4-be75-41ff8d0d507b",
"company_sector_code": "sample string 41",
"is_lead": true,
"is_subcontractor": true,
"latitude": 1.0,
"longitude": 1.0,
"street2": "sample string 44",
"bic_code": "sample string 45",
"specialities": "sample string 46",
"register_number": "sample string 47",
"register_city": "sample string 48",
"bankaccount": "sample string 49",
"mobile": "sample string 50",
"service_manager_user_id": "3a071d5d-af9e-40f7-ad56-16e88c64f3e4",
"service_manager_user_code": "sample string 52",
"finance_manager_user_id": "05280b84-a1f0-441e-a2e7-14818757aef3",
"finance_manager_user_code": "sample string 54",
"account_manager_user_id": "325d23d4-fbc9-425f-bfa1-6e8cee02821e",
"account_manager_user_code": "sample string 56",
"company_status_id": "2ae6d5c7-0c80-4008-98a5-747f9682abba",
"invoice_email_to": "sample string 58",
"modified_dateutc": "2026-04-08T01:17:12.1956979+00:00",
"id2": 60
},
"db_language_id": "c0114d72-b6fd-4923-84a5-4fcf55390420",
"db_language_code": "sample string 7",
"db_title_id": "1ce11889-6a75-427d-b441-4678041b2b07",
"archived": true,
"functions": "sample string 10",
"e_login": "sample string 11",
"e_password": "sample string 12",
"notes": "sample string 13",
"birthdate": "2026-04-08T01:17:12.1956979+00:00",
"create_date": "2026-04-08T01:17:12.1956979+00:00",
"phone": "sample string 16",
"mobile": "sample string 17",
"email": "sample string 18",
"skype": "sample string 19",
"private_phone": "sample string 20",
"private_mobile": "sample string 21",
"private_email": "sample string 22",
"reference_back_office": "sample string 23",
"modified_dateutc": "2026-04-08T01:17:12.1956979+00:00"
},
"modified_dateutc": "2026-04-08T01:17:12.1956979+00:00",
"id2": 22
}