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": "6da3c8ed-abf1-4647-8043-b9c588240355",
"_parent_id": "506e276c-55a1-4644-922c-3a5665660010",
"_parent_reference_back_office": "sample string 3",
"project_status_id": "1394f21a-58c2-4208-ad92-a661c1ea8cb6",
"company_id": "b0dac037-92ff-44ef-8e96-bea540340443",
"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": "ac898a59-4d5f-47ed-a430-92326b7e473e",
"db_country_code": "sample string 17",
"street2": "sample string 18",
"latitude_decimal": 1.0,
"longitude_decimal": 1.0,
"contact_id": "b5086c38-6bbc-4636-be69-0920d46ba12a",
"contact_reference_back_office": "sample string 20",
"contact": {
"id": "790ad8f2-fe45-4d53-9a98-8bd5ac658def",
"firstname": "sample string 2",
"lastname": "sample string 3",
"company_id": "b66c33af-d13f-4294-b950-9104f77076bf",
"company_code": "sample string 5",
"company": {
"id": "5af436f6-2d17-4d17-bad0-8168bd9b5016",
"is_client": true,
"is_supplier": true,
"archived": true,
"name": "sample string 5",
"notes": "sample string 6",
"create_date": "2025-12-27T17:00:59.714197+00:00",
"sales_territory_id": "8c543d4a-0537-4dc5-9ba0-19582c58d47e",
"sales_territory_code": "sample string 9",
"sales_territory": {
"id": "3cb9c9b3-da0f-4b80-9900-e093c08b2879",
"code": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "c0557bb8-5c26-4797-8cf8-d512de021a18",
"sales_organization_code": "sample string 5",
"sales_organization": {
"id": "c10a4c55-de46-4caa-aec0-4a28432f7ad5",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "88886f32-4401-4deb-ab91-05af630b1f03",
"db_currency_id": "be11f7d1-241c-459d-8e0d-998a32222253",
"db_language_id": "f518789d-b032-46a7-aa5a-f59312cad79f",
"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-12-27T17:00:59.714197+00:00"
},
"modified_dateutc": "2025-12-27T17:00:59.714197+00:00"
},
"marketing_segment_id": "018ee1e6-67a0-4b9a-845d-df66e6e35bd7",
"marketing_segment_code": "sample string 11",
"sales_organization_id": "1287e923-6e0e-4502-a2f8-5e495356dcb9",
"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": "5a3431f6-810c-4336-819b-c48d6d1bd1e5",
"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": "c1975370-b0a2-4f7a-922d-000b5b18b83b",
"db_country_code": "sample string 28",
"feelist_id": "9ac3e4fa-4d76-4c29-af06-f4e5192734b2",
"feelist_reference_back_office": "sample string 30",
"feelist": {
"id": "3fc4b736-2b88-4131-a8e3-3ef8f2ebe303",
"name": "sample string 2",
"description": "sample string 3",
"is_default": true,
"default_price": 1.0,
"sales_organization_id": "60984005-4306-4042-86c9-21774969a0e5",
"sales_organization_code": "sample string 6",
"reference_back_office": "sample string 7",
"modified_dateutc": "2025-12-27T17:00:59.7298249+00:00",
"db_currency_id": "d2fda54f-7317-455c-ac8c-83bbefa235d8",
"db_currency_code": "sample string 10"
},
"company_type_id": "65b44e6b-3ed7-408d-9db2-e8d6eb05b334",
"company_type_name": "sample string 32",
"company_type": {
"id": "58b7a8ad-d48f-4472-bbf3-b11f93291ec9",
"name": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "1074f035-8d30-4b28-803b-cf852286637b",
"sales_organization_code": "sample string 5"
},
"db_language_id": "c29327ff-cb22-4a44-ac78-2c3efe54976d",
"db_language_code": "sample string 34",
"code": "sample string 35",
"article_price_label_id": "47259483-def6-4de2-ad1b-4f4ebb9f5fae",
"article_price_label_code": "sample string 37",
"db_payment_method_id": "58515ad5-fd76-41d3-a6d4-c89f2c6b53b1",
"db_payment_method_reference_back_office": "sample string 39",
"db_payment_methods": {
"id": "a3f53801-95cf-4fc2-9e1a-e42ea2a0eb9c",
"name": "sample string 2",
"description": "sample string 3",
"reference_back_office": "sample string 4",
"activated": true,
"modified_dateutc": "2025-12-27T17:00:59.7298249+00:00"
},
"company_sector_id": "8fd5789a-cecc-46ad-9031-f002da84100e",
"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": "d2a36b68-ec57-4f3b-9406-f08d9f57bc5c",
"service_manager_user_code": "sample string 52",
"finance_manager_user_id": "51a6a424-caa6-4e5d-a0cc-985239a69629",
"finance_manager_user_code": "sample string 54",
"account_manager_user_id": "7636d45c-1fdd-46b2-aae4-1489d9245101",
"account_manager_user_code": "sample string 56",
"company_status_id": "84123b95-a0e1-4178-b133-337829b18e98",
"invoice_email_to": "sample string 58",
"modified_dateutc": "2025-12-27T17:00:59.7298249+00:00",
"id2": 60
},
"db_language_id": "49147a70-bd91-4e16-b6cf-ebb723723594",
"db_language_code": "sample string 7",
"db_title_id": "5ac2556e-5f38-491f-a68f-eb00cd661049",
"archived": true,
"functions": "sample string 10",
"e_login": "sample string 11",
"e_password": "sample string 12",
"notes": "sample string 13",
"birthdate": "2025-12-27T17:00:59.7298249+00:00",
"create_date": "2025-12-27T17:00:59.7298249+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-12-27T17:00:59.7298249+00:00"
},
"modified_dateutc": "2025-12-27T17:00:59.7298249+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": "383cecbc-0053-4ac5-9113-0a3d89991f48",
"_parent_id": "848bd4cd-bcf5-4c3f-9614-bed8f67fcbf2",
"_parent_reference_back_office": "sample string 3",
"project_status_id": "4fdf879c-29ca-4c54-9a1c-9b3040bbbdb9",
"company_id": "918cf300-4bdd-4df5-8f1b-884f977a1004",
"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": "f219d6b4-6842-477b-b1ab-a2783aa42b4d",
"db_country_code": "sample string 17",
"street2": "sample string 18",
"latitude_decimal": 1.0,
"longitude_decimal": 1.0,
"contact_id": "7c405a43-b5b8-47ce-84ec-05532b0990b6",
"contact_reference_back_office": "sample string 20",
"contact": {
"id": "11036723-478d-49c1-bcec-4f0af64c6985",
"firstname": "sample string 2",
"lastname": "sample string 3",
"company_id": "3bae8366-bbfe-4206-ac16-f4e76dc52b31",
"company_code": "sample string 5",
"company": {
"id": "aeb5a7ff-b575-4154-8cd3-fb2beeedd5e4",
"is_client": true,
"is_supplier": true,
"archived": true,
"name": "sample string 5",
"notes": "sample string 6",
"create_date": "2025-12-27T17:00:59.7298249+00:00",
"sales_territory_id": "3cc63244-467c-46a6-a1b1-dfe8076c78cf",
"sales_territory_code": "sample string 9",
"sales_territory": {
"id": "b87a248a-2096-4e44-ba31-52f92f0ffdfa",
"code": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "3336a692-41bf-468c-8046-6e41ab4ae5cb",
"sales_organization_code": "sample string 5",
"sales_organization": {
"id": "3a2df5e4-e90f-47b6-b308-93edc74dad7b",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "ae01bef5-e6fd-4c92-a186-a464cc159692",
"db_currency_id": "3daef04c-ed43-43ef-b0ca-c88ebaa05e60",
"db_language_id": "d72db524-7737-436b-b66c-a7c6e6cdb7f5",
"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-12-27T17:00:59.7298249+00:00"
},
"modified_dateutc": "2025-12-27T17:00:59.7298249+00:00"
},
"marketing_segment_id": "c30bc891-7790-4e27-869f-21edf376252c",
"marketing_segment_code": "sample string 11",
"sales_organization_id": "435717de-1596-4bff-ab41-0b6785cb261b",
"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": "73f52674-a732-40c2-8169-800abfe85f48",
"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": "e39dd1fa-97ee-4c06-aaa1-1a4f12d6d1b8",
"db_country_code": "sample string 28",
"feelist_id": "dd417e6a-2fd8-40b0-b87a-069f070f078e",
"feelist_reference_back_office": "sample string 30",
"feelist": {
"id": "6b1ff94a-1051-4be1-9540-2564fd567d21",
"name": "sample string 2",
"description": "sample string 3",
"is_default": true,
"default_price": 1.0,
"sales_organization_id": "47aafeae-1e0c-4d9b-9bf6-91dbf41b3833",
"sales_organization_code": "sample string 6",
"reference_back_office": "sample string 7",
"modified_dateutc": "2025-12-27T17:00:59.7298249+00:00",
"db_currency_id": "d33f6fa0-4fb8-42b5-acf9-8239864401a7",
"db_currency_code": "sample string 10"
},
"company_type_id": "129e65fa-8390-4e78-b44b-832ae226c259",
"company_type_name": "sample string 32",
"company_type": {
"id": "dabcda89-bf5f-495a-b293-197078cb2bfc",
"name": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "14daebf2-1c66-4c8e-8435-8803b055dde3",
"sales_organization_code": "sample string 5"
},
"db_language_id": "5d2ac76f-8cf3-48b8-bc9b-801401a4dacf",
"db_language_code": "sample string 34",
"code": "sample string 35",
"article_price_label_id": "bfbd0667-f9a9-4dfe-8cf7-cf8297b1fd06",
"article_price_label_code": "sample string 37",
"db_payment_method_id": "bf9f8089-6516-49e8-9971-8a9310b7d428",
"db_payment_method_reference_back_office": "sample string 39",
"db_payment_methods": {
"id": "6a3836fe-40e2-4cbc-a0f1-f594d2e26fde",
"name": "sample string 2",
"description": "sample string 3",
"reference_back_office": "sample string 4",
"activated": true,
"modified_dateutc": "2025-12-27T17:00:59.7298249+00:00"
},
"company_sector_id": "1f52cc33-a94a-4122-925c-bf3e4c21b21b",
"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": "7aac5a00-4189-44b8-a8c8-93c07b2d9e5e",
"service_manager_user_code": "sample string 52",
"finance_manager_user_id": "14ae1a98-f563-41b2-8acf-8324dc14303a",
"finance_manager_user_code": "sample string 54",
"account_manager_user_id": "7cce7366-3b11-4395-bc86-a10cf5a32233",
"account_manager_user_code": "sample string 56",
"company_status_id": "32edd405-dc31-4497-b5ef-b8be53b7d1c2",
"invoice_email_to": "sample string 58",
"modified_dateutc": "2025-12-27T17:00:59.7298249+00:00",
"id2": 60
},
"db_language_id": "4409ecb3-2dd8-4992-8667-e7ae1a006203",
"db_language_code": "sample string 7",
"db_title_id": "b91910b2-621c-4042-9b8c-51e41e1b7ca4",
"archived": true,
"functions": "sample string 10",
"e_login": "sample string 11",
"e_password": "sample string 12",
"notes": "sample string 13",
"birthdate": "2025-12-27T17:00:59.7298249+00:00",
"create_date": "2025-12-27T17:00:59.7298249+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-12-27T17:00:59.7298249+00:00"
},
"modified_dateutc": "2025-12-27T17:00:59.7298249+00:00",
"id2": 22
}