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": "e02c16d2-1f5e-46c8-b573-3a00a2cd782a",
"_parent_id": "b5bd404b-1af7-4aa7-ab3a-7beb14b105bd",
"_parent_reference_back_office": "sample string 3",
"project_status_id": "9c03cdc9-3b95-4aeb-bf2d-b9ce13acf552",
"company_id": "2ddfc8cc-d9f8-426a-9996-516a9d62f377",
"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": "d7e698d3-6180-4b86-a4a4-0ee68e4ef3c5",
"db_country_code": "sample string 17",
"street2": "sample string 18",
"latitude_decimal": 1.0,
"longitude_decimal": 1.0,
"contact_id": "278b81a7-be5f-4ee7-92c3-1865bbb06c5a",
"contact_reference_back_office": "sample string 20",
"contact": {
"id": "0eb24326-688a-44a2-aa6e-431b37ee392b",
"firstname": "sample string 2",
"lastname": "sample string 3",
"company_id": "6ec162a4-d99e-44b4-9e57-edd6c3c3e006",
"company_code": "sample string 5",
"company": {
"id": "8ca43fb1-f867-4209-8b5a-5dc2ee11ba6a",
"is_client": true,
"is_supplier": true,
"archived": true,
"name": "sample string 5",
"notes": "sample string 6",
"create_date": "2026-02-28T10:15:58.7956597+00:00",
"sales_territory_id": "baad2820-2a5a-4df5-8fb2-79e34a2facb8",
"sales_territory_code": "sample string 9",
"sales_territory": {
"id": "d6094b48-1e18-44a7-980a-db8438131d4a",
"code": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "e8b16d41-882a-424c-b160-66a85012e8f5",
"sales_organization_code": "sample string 5",
"sales_organization": {
"id": "c8290fcf-9b69-4c91-951f-f7d8009e715b",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "6936246c-185d-4919-bbd7-6ed2a0f4d5d8",
"db_currency_id": "ebfa9973-71a7-4d96-afa0-5585b72b48e5",
"db_language_id": "cbf745cd-4aab-49b9-982d-2cd2a2d82363",
"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-02-28T10:15:58.7956597+00:00"
},
"modified_dateutc": "2026-02-28T10:15:58.7956597+00:00"
},
"marketing_segment_id": "9f0cec8a-72d4-4950-b90a-182d3aad3ff3",
"marketing_segment_code": "sample string 11",
"sales_organization_id": "bd860d9d-585c-486d-9718-06bfe9b6d7ce",
"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": "aaa119a1-5b59-4444-a49a-a3d8fff5dfc3",
"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": "9cb7dda1-fd71-4c1b-9ea4-ff7e24f28ee2",
"db_country_code": "sample string 28",
"feelist_id": "6437461a-11f4-4dd3-8c91-e2c221b03640",
"feelist_reference_back_office": "sample string 30",
"feelist": {
"id": "5eb20062-f1d3-4dc3-ac92-b83269d82ba6",
"name": "sample string 2",
"description": "sample string 3",
"is_default": true,
"default_price": 1.0,
"sales_organization_id": "325c9025-9212-4c1f-bcab-66772de692e0",
"sales_organization_code": "sample string 6",
"reference_back_office": "sample string 7",
"modified_dateutc": "2026-02-28T10:15:58.7956597+00:00",
"db_currency_id": "e4a2d7c5-08b5-442e-850c-0d2b1b6829b0",
"db_currency_code": "sample string 10"
},
"company_type_id": "e8f4a4bd-10e2-4554-9ca0-2ecc27bdd94c",
"company_type_name": "sample string 32",
"company_type": {
"id": "342ee7f3-2647-47a6-8b9a-c8824df2475e",
"name": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "ae03b8c7-e3d4-40eb-8a68-31364d666cbd",
"sales_organization_code": "sample string 5"
},
"db_language_id": "a23f30b0-0603-40c7-9fa0-0c7d25264b13",
"db_language_code": "sample string 34",
"code": "sample string 35",
"article_price_label_id": "c85b875e-6a2c-4eba-9c2b-09201f1bfe25",
"article_price_label_code": "sample string 37",
"db_payment_method_id": "37f66d5a-7654-4f67-b0f6-0773b13274fd",
"db_payment_method_reference_back_office": "sample string 39",
"db_payment_methods": {
"id": "ec617531-1aba-4154-a8da-33389bad876b",
"name": "sample string 2",
"description": "sample string 3",
"reference_back_office": "sample string 4",
"activated": true,
"modified_dateutc": "2026-02-28T10:15:58.7956597+00:00"
},
"company_sector_id": "f74f9b1b-fa55-4e26-8e83-a11ed1ca0df3",
"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": "f8cb4f05-0532-403a-9ec6-9fa5f2a13d48",
"service_manager_user_code": "sample string 52",
"finance_manager_user_id": "543a10b4-1d85-403c-80e0-52b5a0f2ca5f",
"finance_manager_user_code": "sample string 54",
"account_manager_user_id": "c3e223e2-2369-4385-af08-fd3ec0e63bb1",
"account_manager_user_code": "sample string 56",
"company_status_id": "657301c9-61d2-4315-995b-9be88aaec90b",
"invoice_email_to": "sample string 58",
"modified_dateutc": "2026-02-28T10:15:58.7956597+00:00",
"id2": 60
},
"db_language_id": "acc913f4-4e1b-45b9-9d44-217ca71d46c1",
"db_language_code": "sample string 7",
"db_title_id": "798ec4a4-adb9-4184-9f72-2544127c66b4",
"archived": true,
"functions": "sample string 10",
"e_login": "sample string 11",
"e_password": "sample string 12",
"notes": "sample string 13",
"birthdate": "2026-02-28T10:15:58.7956597+00:00",
"create_date": "2026-02-28T10:15:58.7956597+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-02-28T10:15:58.7956597+00:00"
},
"modified_dateutc": "2026-02-28T10:15:58.7956597+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": "b2def675-5f5e-4212-83af-c89c95fed546",
"_parent_id": "f0bac415-8a46-4da2-8f24-b09682adaeb2",
"_parent_reference_back_office": "sample string 3",
"project_status_id": "31f559c2-c5a5-4db4-b9ea-b0a656718181",
"company_id": "0de5903d-b5f3-4f10-85b2-d897baf96164",
"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": "6636bfb8-0cd5-45a2-8ce8-cc90e415bb53",
"db_country_code": "sample string 17",
"street2": "sample string 18",
"latitude_decimal": 1.0,
"longitude_decimal": 1.0,
"contact_id": "e5dd9533-4660-4d33-a9cd-00b1520a23e2",
"contact_reference_back_office": "sample string 20",
"contact": {
"id": "551cfb6e-bd85-4462-b2f1-76db4f18bf6b",
"firstname": "sample string 2",
"lastname": "sample string 3",
"company_id": "2ab6a4a4-59b9-437f-b9a6-9006fde2ddad",
"company_code": "sample string 5",
"company": {
"id": "1704b546-038c-44a0-a5e5-7903cf1f6423",
"is_client": true,
"is_supplier": true,
"archived": true,
"name": "sample string 5",
"notes": "sample string 6",
"create_date": "2026-02-28T10:15:58.826912+00:00",
"sales_territory_id": "e4360b7b-742d-443f-96d3-e42a5229267e",
"sales_territory_code": "sample string 9",
"sales_territory": {
"id": "1dce910a-ed5d-4cde-9f7a-b6533989958d",
"code": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "cf6e340e-9a93-44b3-aa6a-e5502188927a",
"sales_organization_code": "sample string 5",
"sales_organization": {
"id": "159a37c2-79da-47de-a721-c994628356cf",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "94e2a216-fb66-4b19-ad6c-cbdfd45c19b1",
"db_currency_id": "7ff2a12d-600b-4040-8cc3-9b47e2d5e1b2",
"db_language_id": "10cbbc7c-b612-43ff-9036-4610c15c5c24",
"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-02-28T10:15:58.826912+00:00"
},
"modified_dateutc": "2026-02-28T10:15:58.826912+00:00"
},
"marketing_segment_id": "81f14d40-96ed-408e-a7c5-280413a89952",
"marketing_segment_code": "sample string 11",
"sales_organization_id": "454fde16-213b-4eea-9d87-1de641aed515",
"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": "f369c6ce-9ef2-4d66-a177-4166d51e3b13",
"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": "9c706fbe-a20b-412c-be0e-6f40912cce04",
"db_country_code": "sample string 28",
"feelist_id": "55accb66-26ec-4e30-8770-90318b4b8d92",
"feelist_reference_back_office": "sample string 30",
"feelist": {
"id": "8762de59-29f2-49b2-83fe-d706fcf3f25e",
"name": "sample string 2",
"description": "sample string 3",
"is_default": true,
"default_price": 1.0,
"sales_organization_id": "3c6433a1-3121-4ced-a463-db37db07b46a",
"sales_organization_code": "sample string 6",
"reference_back_office": "sample string 7",
"modified_dateutc": "2026-02-28T10:15:58.826912+00:00",
"db_currency_id": "68df1f09-cefc-4540-9e51-b0b348fecb17",
"db_currency_code": "sample string 10"
},
"company_type_id": "7fbe3526-74bc-41c1-a4a0-f977f99744d2",
"company_type_name": "sample string 32",
"company_type": {
"id": "aa8afcbe-246e-44cb-9dc0-85338bb5cf50",
"name": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "c55e4e0b-525c-4d79-be68-d1452bbf8b85",
"sales_organization_code": "sample string 5"
},
"db_language_id": "0c355c98-3982-480c-b860-e9711605d1fe",
"db_language_code": "sample string 34",
"code": "sample string 35",
"article_price_label_id": "83c6f276-ca55-434c-a53a-e229ab9b1765",
"article_price_label_code": "sample string 37",
"db_payment_method_id": "8280ce53-430f-4c90-a06d-45c08e8f8510",
"db_payment_method_reference_back_office": "sample string 39",
"db_payment_methods": {
"id": "7d2496f9-d01d-45f3-9505-4daf2106aec1",
"name": "sample string 2",
"description": "sample string 3",
"reference_back_office": "sample string 4",
"activated": true,
"modified_dateutc": "2026-02-28T10:15:58.826912+00:00"
},
"company_sector_id": "fdd70357-d6bd-45a0-b4cf-f19d189c4a05",
"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": "e3646a45-e3e8-4c56-880e-44e2bdba5dd8",
"service_manager_user_code": "sample string 52",
"finance_manager_user_id": "05d1e56b-804e-42ab-a543-4fe9cafdaafa",
"finance_manager_user_code": "sample string 54",
"account_manager_user_id": "3915f1bf-0b5d-491e-8ff3-a9517dcbd728",
"account_manager_user_code": "sample string 56",
"company_status_id": "77784fc7-c5ad-4c10-b006-dd35bbc6883f",
"invoice_email_to": "sample string 58",
"modified_dateutc": "2026-02-28T10:15:58.826912+00:00",
"id2": 60
},
"db_language_id": "d513c416-6d1f-422c-9941-b9641d594b32",
"db_language_code": "sample string 7",
"db_title_id": "abd62a1f-d3dc-4569-b593-1a76f4cfbf38",
"archived": true,
"functions": "sample string 10",
"e_login": "sample string 11",
"e_password": "sample string 12",
"notes": "sample string 13",
"birthdate": "2026-02-28T10:15:58.8425384+00:00",
"create_date": "2026-02-28T10:15:58.8425384+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-02-28T10:15:58.8425384+00:00"
},
"modified_dateutc": "2026-02-28T10:15:58.8425384+00:00",
"id2": 22
}