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": "87e9ea8d-ecb4-458a-98af-b12001bf4a51",
"_parent_id": "5431d559-258e-4d35-86f9-3a11ed1f15be",
"_parent_reference_back_office": "sample string 3",
"project_status_id": "7b49bccd-a8f2-4ff8-9c46-868c886d40fd",
"company_id": "49cfece3-5fa7-4a97-b8de-bba757fc10e4",
"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": "ec9d8476-6707-4bd5-82d6-ed8d6fde94dd",
"db_country_code": "sample string 17",
"street2": "sample string 18",
"latitude_decimal": 1.0,
"longitude_decimal": 1.0,
"contact_id": "40cbb97a-577d-4d61-8be0-45f86f37b86a",
"contact_reference_back_office": "sample string 20",
"contact": {
"id": "6fe73211-a45f-4673-aff5-fa92fd939d7d",
"firstname": "sample string 2",
"lastname": "sample string 3",
"company_id": "9fad448f-3618-4283-aad8-fe48ba39ec0b",
"company_code": "sample string 5",
"company": {
"id": "b2a3b68d-dc0a-4a37-8cad-92dc7870e215",
"is_client": true,
"is_supplier": true,
"archived": true,
"name": "sample string 5",
"notes": "sample string 6",
"create_date": "2026-06-14T02:15:48.0214875+00:00",
"sales_territory_id": "4cf3acce-ecb2-46d2-9d4c-bbd89148eed2",
"sales_territory_code": "sample string 9",
"sales_territory": {
"id": "38ec574c-5111-4236-aede-117db2df9acb",
"code": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "8c0b1f40-702e-4c61-ae91-81e1ece52020",
"sales_organization_code": "sample string 5",
"sales_organization": {
"id": "6cd33244-b1d9-4155-9aec-dd9872fc359f",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "93a0338e-4983-4ac8-b58a-9fb066f31d7c",
"db_currency_id": "28031f5b-1d47-41c6-90c8-b68ad0da11c4",
"db_language_id": "926169cf-0eeb-4a56-a01a-a936cc9f2320",
"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-06-14T02:15:48.0214875+00:00"
},
"modified_dateutc": "2026-06-14T02:15:48.0214875+00:00"
},
"marketing_segment_id": "216823cc-70c4-4775-beba-d6ad69cdc888",
"marketing_segment_code": "sample string 11",
"sales_organization_id": "3dee4f75-6763-44f3-bb22-6cbbf24b67bb",
"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": "8cfcc5cb-982e-4071-9f1e-d19ee4cff28e",
"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": "68eb739f-c017-4d98-87ed-155e751fe45f",
"db_country_code": "sample string 28",
"feelist_id": "371cd5ed-2a63-450e-8d68-9ffdafcd93d4",
"feelist_reference_back_office": "sample string 30",
"feelist": {
"id": "02461499-6f31-4e2f-81ac-e3a44367af5b",
"name": "sample string 2",
"description": "sample string 3",
"is_default": true,
"default_price": 1.0,
"sales_organization_id": "e6c109ec-8869-45f1-9a82-ebdb5450009e",
"sales_organization_code": "sample string 6",
"reference_back_office": "sample string 7",
"modified_dateutc": "2026-06-14T02:15:48.0214875+00:00",
"db_currency_id": "30cb329a-fb57-4734-9774-30498147f6ff",
"db_currency_code": "sample string 10"
},
"company_type_id": "9e4133f3-1367-411c-941d-056f4df5636d",
"company_type_name": "sample string 32",
"company_type": {
"id": "40e65eb7-d51b-4f2e-a92d-58e884d7786e",
"name": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "527db430-db70-4173-95bd-d72e5110b231",
"sales_organization_code": "sample string 5"
},
"db_language_id": "a05319ad-ab40-4fe0-ac45-276faaf79112",
"db_language_code": "sample string 34",
"code": "sample string 35",
"article_price_label_id": "5f3dc6a0-f881-4572-8576-d549c132d220",
"article_price_label_code": "sample string 37",
"db_payment_method_id": "bedbaf9b-cbdb-453c-bc07-f21a965a3f16",
"db_payment_method_reference_back_office": "sample string 39",
"db_payment_methods": {
"id": "cc2cb6dc-d842-46d3-b717-7f02031b7e8f",
"name": "sample string 2",
"description": "sample string 3",
"reference_back_office": "sample string 4",
"activated": true,
"modified_dateutc": "2026-06-14T02:15:48.0214875+00:00"
},
"company_sector_id": "169e7e09-b89f-4b52-acae-782439781df7",
"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": "8567f424-1e38-49e6-b38a-51c1460cf816",
"service_manager_user_code": "sample string 52",
"finance_manager_user_id": "60df23e2-bae0-4b3f-9c8c-c20c2b5a96d9",
"finance_manager_user_code": "sample string 54",
"account_manager_user_id": "3ccfa715-6ba3-49a8-9479-595e9f7f1059",
"account_manager_user_code": "sample string 56",
"company_status_id": "7fb5bdf6-eed9-4e3e-bb0f-21f8366000ea",
"invoice_email_to": "sample string 58",
"modified_dateutc": "2026-06-14T02:15:48.0214875+00:00",
"id2": 60
},
"db_language_id": "4173e0ef-fff3-4036-b652-80cebb2d56d1",
"db_language_code": "sample string 7",
"db_title_id": "85897303-eb26-4209-86a8-7688e9bb32e3",
"archived": true,
"functions": "sample string 10",
"e_login": "sample string 11",
"e_password": "sample string 12",
"notes": "sample string 13",
"birthdate": "2026-06-14T02:15:48.0214875+00:00",
"create_date": "2026-06-14T02:15:48.0214875+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-06-14T02:15:48.0214875+00:00"
},
"modified_dateutc": "2026-06-14T02:15:48.0214875+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": "d9865623-50cd-43bf-9294-e232bcff1d05",
"_parent_id": "d1c50d05-5ab5-4097-a7dd-e53bd3cfc32b",
"_parent_reference_back_office": "sample string 3",
"project_status_id": "2da5d644-3695-417b-80f9-62a8ac77b906",
"company_id": "a0406341-7755-4960-b033-22e208a72458",
"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": "eb37de60-e25a-4af5-8953-b1e3cd1d8745",
"db_country_code": "sample string 17",
"street2": "sample string 18",
"latitude_decimal": 1.0,
"longitude_decimal": 1.0,
"contact_id": "08e73c02-5f11-4a68-a054-e44c0701b3e1",
"contact_reference_back_office": "sample string 20",
"contact": {
"id": "b46ae026-8fbb-48af-9075-85f38e68c1e0",
"firstname": "sample string 2",
"lastname": "sample string 3",
"company_id": "79915ca7-90b4-4f70-acb5-8c63837ab934",
"company_code": "sample string 5",
"company": {
"id": "7552349d-869c-45d6-a6b3-7f8173c986f9",
"is_client": true,
"is_supplier": true,
"archived": true,
"name": "sample string 5",
"notes": "sample string 6",
"create_date": "2026-06-14T02:15:48.0371093+00:00",
"sales_territory_id": "efe2a917-577d-40a9-a676-2fbf2267f7c7",
"sales_territory_code": "sample string 9",
"sales_territory": {
"id": "85688e1a-7eb6-4257-8b27-65992504b38d",
"code": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "094c087d-a7c3-4305-841b-6a331352f5f2",
"sales_organization_code": "sample string 5",
"sales_organization": {
"id": "254ff957-64ca-4ab8-a5ed-0f7459fcb442",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "b25acab6-ff47-4c96-9e56-d246109de6b2",
"db_currency_id": "a6665027-c93e-4ef8-be7c-0abf8b899bd7",
"db_language_id": "086b67e9-0169-411b-a8e0-f9976705a28b",
"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-06-14T02:15:48.0371093+00:00"
},
"modified_dateutc": "2026-06-14T02:15:48.0371093+00:00"
},
"marketing_segment_id": "ff423239-c5e2-416b-bbc7-dd3bfdf1f0ea",
"marketing_segment_code": "sample string 11",
"sales_organization_id": "2037a618-b1ef-4fa6-adc9-dac5c0bb4ee2",
"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": "0e3de898-03ca-4a49-8f26-e6d36bd0a18a",
"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": "edfd8e44-e4e1-4140-9be5-212c58954694",
"db_country_code": "sample string 28",
"feelist_id": "d0ddfe29-3bbe-4a10-bf5f-2624031b9d3c",
"feelist_reference_back_office": "sample string 30",
"feelist": {
"id": "67b6e8fb-52be-44f8-ae3a-86859c3acb3b",
"name": "sample string 2",
"description": "sample string 3",
"is_default": true,
"default_price": 1.0,
"sales_organization_id": "bf9ef864-7c12-4a70-9077-7295d7a25b0f",
"sales_organization_code": "sample string 6",
"reference_back_office": "sample string 7",
"modified_dateutc": "2026-06-14T02:15:48.0371093+00:00",
"db_currency_id": "3d6900cd-471c-471f-9ac9-d40a69632e3a",
"db_currency_code": "sample string 10"
},
"company_type_id": "962ca7fd-488c-440d-a494-368391e91b43",
"company_type_name": "sample string 32",
"company_type": {
"id": "b42e4a1f-c3ab-4f4f-80c2-4b62b4cec16b",
"name": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "e459f3c7-c1ed-4b81-8558-94002d3570ba",
"sales_organization_code": "sample string 5"
},
"db_language_id": "3244534b-10de-419a-81cb-759216960182",
"db_language_code": "sample string 34",
"code": "sample string 35",
"article_price_label_id": "a4f074c0-f283-4da2-bf78-3bec17cc70ae",
"article_price_label_code": "sample string 37",
"db_payment_method_id": "44855e9c-3e48-4809-9870-a413be4c2382",
"db_payment_method_reference_back_office": "sample string 39",
"db_payment_methods": {
"id": "58a9cad6-b59b-4644-ad63-df901303bbd6",
"name": "sample string 2",
"description": "sample string 3",
"reference_back_office": "sample string 4",
"activated": true,
"modified_dateutc": "2026-06-14T02:15:48.0371093+00:00"
},
"company_sector_id": "d338a5b0-90e2-4676-86c7-2609ff003dd2",
"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": "cf1308a4-1932-44f1-9276-daa05f72d7d3",
"service_manager_user_code": "sample string 52",
"finance_manager_user_id": "de0711f5-e522-464f-a613-d290b18d1baf",
"finance_manager_user_code": "sample string 54",
"account_manager_user_id": "504f346c-b9a1-4911-a032-a878f668b0c4",
"account_manager_user_code": "sample string 56",
"company_status_id": "9a4133af-6002-48ae-aa77-4e155dc0b884",
"invoice_email_to": "sample string 58",
"modified_dateutc": "2026-06-14T02:15:48.0371093+00:00",
"id2": 60
},
"db_language_id": "23541d96-3d55-4973-b359-9c9e699b1c93",
"db_language_code": "sample string 7",
"db_title_id": "9548a4f8-aa2c-4d15-9f8b-f8b0af49d944",
"archived": true,
"functions": "sample string 10",
"e_login": "sample string 11",
"e_password": "sample string 12",
"notes": "sample string 13",
"birthdate": "2026-06-14T02:15:48.0371093+00:00",
"create_date": "2026-06-14T02:15:48.0371093+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-06-14T02:15:48.0371093+00:00"
},
"modified_dateutc": "2026-06-14T02:15:48.0371093+00:00",
"id2": 22
}