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": "7fbb97e7-2313-4698-8932-2df7031a47c6",
"_parent_id": "e3f70139-8217-431a-8ec0-4c7c7de1e5eb",
"_parent_reference_back_office": "sample string 3",
"project_status_id": "6b9047a5-e685-4b20-8b6c-d72ad663f4a7",
"company_id": "a3a674d5-63fd-416f-aea1-d457b84170dc",
"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": "991844c5-81c9-4a8e-86ac-de691ab76eb2",
"db_country_code": "sample string 17",
"street2": "sample string 18",
"latitude_decimal": 1.0,
"longitude_decimal": 1.0,
"contact_id": "26c8b0e0-7f25-4fe5-9388-6aca436c3b2b",
"contact_reference_back_office": "sample string 20",
"contact": {
"id": "e1cce1cf-c768-40ba-9081-54c2db9b8be2",
"firstname": "sample string 2",
"lastname": "sample string 3",
"company_id": "98e618ea-4fab-48bc-83ba-9704a60b3f4d",
"company_code": "sample string 5",
"company": {
"id": "87f541ba-4b04-4172-a3d4-ebad9cc01d20",
"is_client": true,
"is_supplier": true,
"archived": true,
"name": "sample string 5",
"notes": "sample string 6",
"create_date": "2026-06-25T22:28:04.0483722+00:00",
"sales_territory_id": "94d4f526-74a0-456b-9358-b65d558b0da6",
"sales_territory_code": "sample string 9",
"sales_territory": {
"id": "7ad69ae7-1d89-4aa8-bb1a-86c8f5173786",
"code": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "a46d7bd0-9462-487a-90ec-a8802d56a48f",
"sales_organization_code": "sample string 5",
"sales_organization": {
"id": "05dc5775-1c6d-4515-a3ce-a8e10a8f5e4a",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "9b14139b-6c15-4421-a9d3-9510b4033d55",
"db_currency_id": "d1e79517-3b95-4729-932f-cbbd0899e706",
"db_language_id": "d451a111-a2c1-41d8-a646-d2274e034257",
"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-25T22:28:04.0483722+00:00"
},
"modified_dateutc": "2026-06-25T22:28:04.0483722+00:00"
},
"marketing_segment_id": "6b580fd7-5806-4c43-99cf-fe2bdbf9b66e",
"marketing_segment_code": "sample string 11",
"sales_organization_id": "4ca98ea1-1f26-4357-aa74-f41c88818eae",
"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": "2e67fcc9-fec1-4505-b8c5-abbf22434a1c",
"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": "3a6885c7-d9a9-4fc7-a040-54bbb337354b",
"db_country_code": "sample string 28",
"feelist_id": "2208bf0b-a928-4763-91fa-5deed90c6302",
"feelist_reference_back_office": "sample string 30",
"feelist": {
"id": "afd3f4e4-eaa8-4fec-8907-f6af070422f6",
"name": "sample string 2",
"description": "sample string 3",
"is_default": true,
"default_price": 1.0,
"sales_organization_id": "758efb00-d41a-487e-94bc-061c27dba6f3",
"sales_organization_code": "sample string 6",
"reference_back_office": "sample string 7",
"modified_dateutc": "2026-06-25T22:28:04.0483722+00:00",
"db_currency_id": "798854b8-eabf-41da-9241-0424b2d73edf",
"db_currency_code": "sample string 10"
},
"company_type_id": "008e641f-ebf1-483b-8bf8-467dae9224d7",
"company_type_name": "sample string 32",
"company_type": {
"id": "3fd890fd-a47c-48a5-9062-b26be1a0bdb8",
"name": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "c798a03d-4622-42f1-a63a-5accab7ff5ab",
"sales_organization_code": "sample string 5"
},
"db_language_id": "62164b3a-d02c-4f20-9c87-53d198237775",
"db_language_code": "sample string 34",
"code": "sample string 35",
"article_price_label_id": "331d678d-4c94-456f-9e24-a1519c3e1ba2",
"article_price_label_code": "sample string 37",
"db_payment_method_id": "6280a9d8-44f4-41f7-b260-e7c7637213c1",
"db_payment_method_reference_back_office": "sample string 39",
"db_payment_methods": {
"id": "33bc7dc9-ed49-4185-981c-4bf22ec77e56",
"name": "sample string 2",
"description": "sample string 3",
"reference_back_office": "sample string 4",
"activated": true,
"modified_dateutc": "2026-06-25T22:28:04.0483722+00:00"
},
"company_sector_id": "98546fb7-2df7-45e3-bc6d-0493548635c6",
"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": "4139bcaf-7e60-4d7c-8d47-0ecfa5382972",
"service_manager_user_code": "sample string 52",
"finance_manager_user_id": "42715a17-86cd-4800-ba9d-844834e6c382",
"finance_manager_user_code": "sample string 54",
"account_manager_user_id": "259a887b-d6e5-4d24-9937-49acb59061a5",
"account_manager_user_code": "sample string 56",
"company_status_id": "3ab34fc7-b1ed-4509-9237-3c4b8a902945",
"invoice_email_to": "sample string 58",
"modified_dateutc": "2026-06-25T22:28:04.0483722+00:00",
"id2": 60
},
"db_language_id": "f37f4078-48fd-42db-b92f-33e13160fdc3",
"db_language_code": "sample string 7",
"db_title_id": "088ee9ca-0e71-4cdf-8ff6-ef08da058548",
"archived": true,
"functions": "sample string 10",
"e_login": "sample string 11",
"e_password": "sample string 12",
"notes": "sample string 13",
"birthdate": "2026-06-25T22:28:04.0483722+00:00",
"create_date": "2026-06-25T22:28:04.0483722+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-25T22:28:04.0483722+00:00"
},
"modified_dateutc": "2026-06-25T22:28:04.0483722+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": "60558fe5-b41f-4371-a6d3-a56f9f4137c5",
"_parent_id": "6977be01-121a-408f-9872-6e6c1633567d",
"_parent_reference_back_office": "sample string 3",
"project_status_id": "02739cb3-0349-4c6a-9224-3bd662f06c18",
"company_id": "231fe527-8ed5-4116-b670-1182f9e069b2",
"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": "c309d026-f669-45ba-b168-832556f343e7",
"db_country_code": "sample string 17",
"street2": "sample string 18",
"latitude_decimal": 1.0,
"longitude_decimal": 1.0,
"contact_id": "87d3e7e1-69af-4bfd-b289-cb47ebe0e804",
"contact_reference_back_office": "sample string 20",
"contact": {
"id": "43e5c748-df60-4171-9f80-f9ecc2d10cb1",
"firstname": "sample string 2",
"lastname": "sample string 3",
"company_id": "6a7ffd33-49fa-4de0-9513-dd2ed1d33c82",
"company_code": "sample string 5",
"company": {
"id": "6857a8aa-84ec-4e17-a3ce-b24fadacdf13",
"is_client": true,
"is_supplier": true,
"archived": true,
"name": "sample string 5",
"notes": "sample string 6",
"create_date": "2026-06-25T22:28:04.0639974+00:00",
"sales_territory_id": "f25d3212-003e-41da-8fea-abc16a258470",
"sales_territory_code": "sample string 9",
"sales_territory": {
"id": "85f3b70b-5190-4121-b588-e0a6a3dcd711",
"code": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "d8bd1c6f-4cb9-46f1-8e90-bbe67be1d5c6",
"sales_organization_code": "sample string 5",
"sales_organization": {
"id": "a101d994-3758-40ec-9d07-96d25906c474",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "c4b6491a-32e7-4740-8af1-dc58419b8654",
"db_currency_id": "8a336e12-ab36-4a88-aad6-ba8fd6f4e547",
"db_language_id": "614ec73e-ef13-43d4-a68d-bcae49f28327",
"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-25T22:28:04.0639974+00:00"
},
"modified_dateutc": "2026-06-25T22:28:04.0639974+00:00"
},
"marketing_segment_id": "f877dbb9-4c28-45bc-a2d9-45314a9e9dbf",
"marketing_segment_code": "sample string 11",
"sales_organization_id": "36bd0e01-f7a7-4b26-8733-0987e3f5b32b",
"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": "47487b3d-251d-457d-a6bf-ec0358502f12",
"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": "73c9f6ed-72fe-4d1a-8d2a-434490e13ec7",
"db_country_code": "sample string 28",
"feelist_id": "cd8de0d6-f2e6-483d-97b5-eaed4a6bceca",
"feelist_reference_back_office": "sample string 30",
"feelist": {
"id": "f1f93df7-49af-4f29-9866-32669eb08bb5",
"name": "sample string 2",
"description": "sample string 3",
"is_default": true,
"default_price": 1.0,
"sales_organization_id": "47199ec8-1a59-4f33-8904-6951a8a3543e",
"sales_organization_code": "sample string 6",
"reference_back_office": "sample string 7",
"modified_dateutc": "2026-06-25T22:28:04.0639974+00:00",
"db_currency_id": "f3b6eae7-6a38-4876-9191-16103b0c7c92",
"db_currency_code": "sample string 10"
},
"company_type_id": "12228a61-8281-4d9f-91be-dd95dcf214cc",
"company_type_name": "sample string 32",
"company_type": {
"id": "6f261053-db92-4224-b5df-2575ea290cf1",
"name": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "de8a646d-cf63-4151-84b8-584ba5bd684c",
"sales_organization_code": "sample string 5"
},
"db_language_id": "9c4659ce-f315-4d79-8217-7f13dcccae3d",
"db_language_code": "sample string 34",
"code": "sample string 35",
"article_price_label_id": "05f92481-98b8-4dd2-ae58-6d6cd576664c",
"article_price_label_code": "sample string 37",
"db_payment_method_id": "dd372a0c-aa5b-482e-acf5-217a13845379",
"db_payment_method_reference_back_office": "sample string 39",
"db_payment_methods": {
"id": "a14a0279-62aa-4175-8bf6-b060004f7c2f",
"name": "sample string 2",
"description": "sample string 3",
"reference_back_office": "sample string 4",
"activated": true,
"modified_dateutc": "2026-06-25T22:28:04.0639974+00:00"
},
"company_sector_id": "ea31223e-3bd0-46db-9e2a-6b5e280595df",
"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": "52802bfb-a8c1-4dca-b76b-a0017a07de99",
"service_manager_user_code": "sample string 52",
"finance_manager_user_id": "7cc789ef-30a3-4bb8-9c22-08e432220055",
"finance_manager_user_code": "sample string 54",
"account_manager_user_id": "ab64600b-b396-4e1e-871a-b958d6dbaa81",
"account_manager_user_code": "sample string 56",
"company_status_id": "da2b559a-b3a9-4724-812d-a95a921895b1",
"invoice_email_to": "sample string 58",
"modified_dateutc": "2026-06-25T22:28:04.0639974+00:00",
"id2": 60
},
"db_language_id": "a17d7118-fc27-490b-a51d-ac0400bbc087",
"db_language_code": "sample string 7",
"db_title_id": "7e5a960c-ff5a-4f29-8465-979c86bbd696",
"archived": true,
"functions": "sample string 10",
"e_login": "sample string 11",
"e_password": "sample string 12",
"notes": "sample string 13",
"birthdate": "2026-06-25T22:28:04.0639974+00:00",
"create_date": "2026-06-25T22:28:04.0639974+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-25T22:28:04.0639974+00:00"
},
"modified_dateutc": "2026-06-25T22:28:04.0639974+00:00",
"id2": 22
}