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": "6932c30e-6bdb-473c-89ce-37211b0db281",
"_parent_id": "8ee27118-993e-46f4-ad11-6ae12c212a41",
"_parent_reference_back_office": "sample string 3",
"project_status_id": "c9d68151-135a-4188-8596-fe2482c9e476",
"company_id": "5b043273-6680-450c-bdb0-7143faaaa7f0",
"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": "202cfc34-9f76-4e78-bdf1-1ac48ba86da2",
"db_country_code": "sample string 17",
"street2": "sample string 18",
"latitude_decimal": 1.0,
"longitude_decimal": 1.0,
"contact_id": "89c879ce-155c-4656-a4bc-cc42193c4264",
"contact_reference_back_office": "sample string 20",
"contact": {
"id": "34b373db-3007-4ba5-87e7-41ddbe35db1a",
"firstname": "sample string 2",
"lastname": "sample string 3",
"company_id": "530118ea-6088-4b0b-8685-6a80eff83b1e",
"company_code": "sample string 5",
"company": {
"id": "0fd889e9-9859-4e7d-89b4-6339a2ce3bac",
"is_client": true,
"is_supplier": true,
"archived": true,
"name": "sample string 5",
"notes": "sample string 6",
"create_date": "2025-07-18T02:55:11.7490075+00:00",
"sales_territory_id": "c196da6e-1f7b-4cd3-b06b-595ad2ffc0dc",
"sales_territory_code": "sample string 9",
"sales_territory": {
"id": "3af2ba30-4629-46ae-8fbf-6fb0b09f5dd8",
"code": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "fd13178b-31ca-4679-a7c4-3cf742c12e84",
"sales_organization_code": "sample string 5",
"sales_organization": {
"id": "66a057f7-de1d-42ba-ae02-07d2b19654f1",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "d58fa305-9c18-41c4-855f-fa4a404953c2",
"db_currency_id": "5bc421fc-24e5-4617-813c-9bd0b1d59137",
"db_language_id": "9531fd08-0471-49ea-99c7-500119aba495",
"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": "2025-07-18T02:55:11.7490075+00:00"
},
"modified_dateutc": "2025-07-18T02:55:11.7490075+00:00"
},
"marketing_segment_id": "81543c80-0927-41dd-99c5-d195ef01376c",
"marketing_segment_code": "sample string 11",
"sales_organization_id": "d00ee80a-70ad-453e-9dd0-241ac9206c6c",
"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": "1ecb39b5-6fb2-421e-9471-5a88d96b5e5c",
"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": "cf550f0a-5d3a-4d33-b566-9dee478b5f01",
"db_country_code": "sample string 28",
"feelist_id": "8a5c672f-abfd-4883-9563-7bcb8434a55b",
"feelist_reference_back_office": "sample string 30",
"feelist": {
"id": "ec07d572-9314-4e3d-b057-6a48828a40db",
"name": "sample string 2",
"description": "sample string 3",
"is_default": true,
"default_price": 1.0,
"sales_organization_id": "70cfa6db-1fa4-4aaf-9d17-92b14d2cbfdc",
"sales_organization_code": "sample string 6",
"reference_back_office": "sample string 7",
"modified_dateutc": "2025-07-18T02:55:11.7490075+00:00",
"db_currency_id": "fa85e98a-e3f8-48cc-9c86-056d13d31b30",
"db_currency_code": "sample string 10"
},
"company_type_id": "2addd2e8-0cdb-4e40-834c-c272e0c7283b",
"company_type_name": "sample string 32",
"company_type": {
"id": "7f866ae3-ae31-4da7-acd8-0a87a7a3aa23",
"name": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "8afebc7e-58ca-4f42-ab07-b97cf92618b1",
"sales_organization_code": "sample string 5"
},
"db_language_id": "f8227a51-9b09-4105-8313-438b254a831c",
"db_language_code": "sample string 34",
"code": "sample string 35",
"article_price_label_id": "bf49db38-a5ba-44d8-8521-bfc3c988ab1c",
"article_price_label_code": "sample string 37",
"db_payment_method_id": "2b6871fe-a23a-4d78-ae5b-4e0017a40714",
"db_payment_method_reference_back_office": "sample string 39",
"db_payment_methods": {
"id": "c55f3aa3-0d9a-4fff-89b2-c9bdf40dec4c",
"name": "sample string 2",
"description": "sample string 3",
"reference_back_office": "sample string 4",
"activated": true,
"modified_dateutc": "2025-07-18T02:55:11.7490075+00:00"
},
"company_sector_id": "396753fd-e97a-45cf-991e-e7f7da314833",
"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": "2ddbcb46-bab1-46fc-9ff3-25a4356d6f53",
"service_manager_user_code": "sample string 52",
"finance_manager_user_id": "d1cb3a85-47f8-4bcf-9526-fd2d33687939",
"finance_manager_user_code": "sample string 54",
"account_manager_user_id": "a1c79300-a8ba-4a6a-ae71-f3250a6afc18",
"account_manager_user_code": "sample string 56",
"company_status_id": "b97a9e11-13d8-4114-b199-8a5869d1dfda",
"invoice_email_to": "sample string 58",
"modified_dateutc": "2025-07-18T02:55:11.7490075+00:00",
"id2": 60
},
"db_language_id": "5314cb20-0b0c-47d3-a4c7-12fcde745fd1",
"db_language_code": "sample string 7",
"db_title_id": "48ada9ab-b343-4b77-8ab6-dcc497e559cd",
"archived": true,
"functions": "sample string 10",
"e_login": "sample string 11",
"e_password": "sample string 12",
"notes": "sample string 13",
"birthdate": "2025-07-18T02:55:11.7490075+00:00",
"create_date": "2025-07-18T02:55:11.7490075+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": "2025-07-18T02:55:11.7490075+00:00"
},
"modified_dateutc": "2025-07-18T02:55:11.7490075+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": "bff95678-48ed-40ba-86fd-bf5e7f9d9a73",
"_parent_id": "889996a8-7665-4bf4-b5e9-41d32e57df7d",
"_parent_reference_back_office": "sample string 3",
"project_status_id": "35cd6811-7796-454a-aebc-135785ae2189",
"company_id": "0d278b97-3005-4908-ae55-25d7fada44fe",
"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": "b2e1d57e-b705-463b-b472-21b51732703b",
"db_country_code": "sample string 17",
"street2": "sample string 18",
"latitude_decimal": 1.0,
"longitude_decimal": 1.0,
"contact_id": "721863d3-7a06-4cac-8023-4ef1c9a48ee5",
"contact_reference_back_office": "sample string 20",
"contact": {
"id": "f7af9caa-f730-4229-9d8c-bed3dad955b0",
"firstname": "sample string 2",
"lastname": "sample string 3",
"company_id": "a3d7983a-a60a-4706-adc4-14d94355f9ba",
"company_code": "sample string 5",
"company": {
"id": "90119935-63b0-429d-b5f0-b2bd1c1f6779",
"is_client": true,
"is_supplier": true,
"archived": true,
"name": "sample string 5",
"notes": "sample string 6",
"create_date": "2025-07-18T02:55:11.9677935+00:00",
"sales_territory_id": "6b508f9f-dd14-4e36-8554-e985f148eb38",
"sales_territory_code": "sample string 9",
"sales_territory": {
"id": "f9f8def4-8966-477b-81a2-aa5dd85c5ee8",
"code": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "277f1c20-3d1e-42bb-9eb3-144be0bcb6df",
"sales_organization_code": "sample string 5",
"sales_organization": {
"id": "92edf441-2ec4-4a5b-ae9d-72f5f64e5f8d",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "90753a9b-77a5-44d0-9967-3f0abbef6730",
"db_currency_id": "532fbc3e-607e-430b-b8c9-7e88c2f7f7ce",
"db_language_id": "fdb9ccdc-bef8-402f-9d89-aeba0908e750",
"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": "2025-07-18T02:55:11.9677935+00:00"
},
"modified_dateutc": "2025-07-18T02:55:11.9677935+00:00"
},
"marketing_segment_id": "4080c6a8-c7db-4043-994f-bed871aa9738",
"marketing_segment_code": "sample string 11",
"sales_organization_id": "4c47cdaf-1783-416f-b9c1-e41869a4652d",
"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": "2fbaec2f-a70e-4afb-9441-986a51615109",
"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": "40175157-2a66-48f7-8de6-ffe2d9fbe9fe",
"db_country_code": "sample string 28",
"feelist_id": "f2db0141-f510-4055-ab48-35e267352309",
"feelist_reference_back_office": "sample string 30",
"feelist": {
"id": "0e00f058-7228-47bd-947a-cd0cc9223ba9",
"name": "sample string 2",
"description": "sample string 3",
"is_default": true,
"default_price": 1.0,
"sales_organization_id": "930618d9-7e91-488c-9ff2-f0b161089b35",
"sales_organization_code": "sample string 6",
"reference_back_office": "sample string 7",
"modified_dateutc": "2025-07-18T02:55:11.9677935+00:00",
"db_currency_id": "fe3e6ffe-cfe3-42f1-b565-f80bf301d710",
"db_currency_code": "sample string 10"
},
"company_type_id": "b1d1509e-f285-41c9-94be-4e23367ac585",
"company_type_name": "sample string 32",
"company_type": {
"id": "d497f032-2b5f-40fb-85ad-650963a1d68b",
"name": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "409624ab-7c81-4607-b0db-3c047d837a93",
"sales_organization_code": "sample string 5"
},
"db_language_id": "6037e07f-ac02-45e7-ad87-03da40cd8295",
"db_language_code": "sample string 34",
"code": "sample string 35",
"article_price_label_id": "aa528716-027c-43a2-92f3-5782f5e3762e",
"article_price_label_code": "sample string 37",
"db_payment_method_id": "311d73a5-9536-47d0-8186-66bf7a22c6ca",
"db_payment_method_reference_back_office": "sample string 39",
"db_payment_methods": {
"id": "ba70a9b1-a38a-476b-b632-b5e44fb076d0",
"name": "sample string 2",
"description": "sample string 3",
"reference_back_office": "sample string 4",
"activated": true,
"modified_dateutc": "2025-07-18T02:55:11.9677935+00:00"
},
"company_sector_id": "bed36420-a968-4ceb-a470-85ab914c1659",
"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": "73a7fc8a-8636-4f21-b7bf-9fac2b8aa31a",
"service_manager_user_code": "sample string 52",
"finance_manager_user_id": "39835cc6-2314-4d30-b49c-7639143d0eef",
"finance_manager_user_code": "sample string 54",
"account_manager_user_id": "9e0f4178-fd13-4565-babc-6755d1e43e95",
"account_manager_user_code": "sample string 56",
"company_status_id": "bfa8af6f-302d-4409-aee4-529645747c37",
"invoice_email_to": "sample string 58",
"modified_dateutc": "2025-07-18T02:55:11.9677935+00:00",
"id2": 60
},
"db_language_id": "8c92d39d-367e-47eb-bf82-eb3193dbad6a",
"db_language_code": "sample string 7",
"db_title_id": "1e0b6c5b-ad17-490e-af95-ad6d63de806e",
"archived": true,
"functions": "sample string 10",
"e_login": "sample string 11",
"e_password": "sample string 12",
"notes": "sample string 13",
"birthdate": "2025-07-18T02:55:11.9833744+00:00",
"create_date": "2025-07-18T02:55:11.9833744+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": "2025-07-18T02:55:11.9833744+00:00"
},
"modified_dateutc": "2025-07-18T02:55:11.9833744+00:00",
"id2": 22
}