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": "55d39a47-4e3e-4266-95e8-055d373718fa",
"_parent_id": "1721b5f7-9103-4d10-b71f-56b8cb074868",
"_parent_reference_back_office": "sample string 3",
"project_status_id": "6bb47385-142e-4353-beb1-1628c59eda84",
"company_id": "db9d2c53-7cda-476b-b3e5-749a4d72b271",
"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": "35cbf875-ebe2-4846-bd5a-87e3568e0f5f",
"db_country_code": "sample string 17",
"street2": "sample string 18",
"latitude_decimal": 1.0,
"longitude_decimal": 1.0,
"contact_id": "ee846374-9c21-4b7d-94ac-bb2aeff5d67e",
"contact_reference_back_office": "sample string 20",
"contact": {
"id": "fa0d1fa0-0676-41ed-9c59-3080e64a1f1d",
"firstname": "sample string 2",
"lastname": "sample string 3",
"company_id": "31d10ccf-b895-4db0-85de-ecc2d5ed44a7",
"company_code": "sample string 5",
"company": {
"id": "81498462-02ad-4e32-ad7d-f7f3a77ed67b",
"is_client": true,
"is_supplier": true,
"archived": true,
"name": "sample string 5",
"notes": "sample string 6",
"create_date": "2025-11-07T18:33:43.2308718+00:00",
"sales_territory_id": "a42a7321-1455-42f5-b3af-e9252c249455",
"sales_territory_code": "sample string 9",
"sales_territory": {
"id": "071e8e1f-4cec-4492-a02e-8738bc245080",
"code": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "739a0ca9-3073-4271-b52b-932998e320fe",
"sales_organization_code": "sample string 5",
"sales_organization": {
"id": "d4b6a54a-279a-4843-a0bd-41079056daf9",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "75641336-9925-4ee5-8e3c-7ac9cb5363e9",
"db_currency_id": "54f2e08d-e236-42fd-86a2-4192e09a5a74",
"db_language_id": "abd86c28-003c-4c9f-8271-cc65ff93e6f6",
"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-11-07T18:33:43.2308718+00:00"
},
"modified_dateutc": "2025-11-07T18:33:43.2308718+00:00"
},
"marketing_segment_id": "2b1d8141-d61d-4d75-b0b3-276f640481da",
"marketing_segment_code": "sample string 11",
"sales_organization_id": "9d314c01-34de-4e65-9087-9a540a0a416d",
"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": "f3403dfb-da88-4936-bd26-ee842882a586",
"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": "d8886db9-025c-4813-98a6-1d4cd2df2d53",
"db_country_code": "sample string 28",
"feelist_id": "c0f47059-d21c-4bea-9823-b2ce76e7923f",
"feelist_reference_back_office": "sample string 30",
"feelist": {
"id": "7e1f8983-a0a2-4323-a17c-7a3867f8a99c",
"name": "sample string 2",
"description": "sample string 3",
"is_default": true,
"default_price": 1.0,
"sales_organization_id": "561e000b-7cff-4a49-81d9-4a9596984d51",
"sales_organization_code": "sample string 6",
"reference_back_office": "sample string 7",
"modified_dateutc": "2025-11-07T18:33:43.2308718+00:00",
"db_currency_id": "37f07dc4-91e4-4f73-b10b-0c8f87e74349",
"db_currency_code": "sample string 10"
},
"company_type_id": "d222a12c-0821-40c6-a441-d9544f3a55b3",
"company_type_name": "sample string 32",
"company_type": {
"id": "44b60655-11a4-498c-90f9-ab517c4f8c05",
"name": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "5aabd045-857a-4dd2-b830-a212e1c6ad55",
"sales_organization_code": "sample string 5"
},
"db_language_id": "dedd899b-1757-47e4-98ef-bb8465936073",
"db_language_code": "sample string 34",
"code": "sample string 35",
"article_price_label_id": "754a2554-8eb2-4d06-80d9-d093dda3caa1",
"article_price_label_code": "sample string 37",
"db_payment_method_id": "55b5368d-02b9-484b-b727-4574d969df0e",
"db_payment_method_reference_back_office": "sample string 39",
"db_payment_methods": {
"id": "519f09fd-9cd3-4860-a9ca-73ba3a9e98e4",
"name": "sample string 2",
"description": "sample string 3",
"reference_back_office": "sample string 4",
"activated": true,
"modified_dateutc": "2025-11-07T18:33:43.2308718+00:00"
},
"company_sector_id": "0c079db9-408a-4f57-8531-90eb57b4f89d",
"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": "0175307c-2f49-4d60-a311-9747e346ea49",
"service_manager_user_code": "sample string 52",
"finance_manager_user_id": "d6adc1e8-e725-4236-a751-0bec4ed6b772",
"finance_manager_user_code": "sample string 54",
"account_manager_user_id": "4b19011c-a686-4d74-9d9e-390c1a5f8ef6",
"account_manager_user_code": "sample string 56",
"company_status_id": "96a17daa-c09e-400c-8829-fead9742cdda",
"invoice_email_to": "sample string 58",
"modified_dateutc": "2025-11-07T18:33:43.2308718+00:00",
"id2": 60
},
"db_language_id": "6f31deba-305d-4e2f-9090-4d28e17ad11a",
"db_language_code": "sample string 7",
"db_title_id": "0a9f2692-d3c4-4b24-b8ae-5f36ab9c0d0f",
"archived": true,
"functions": "sample string 10",
"e_login": "sample string 11",
"e_password": "sample string 12",
"notes": "sample string 13",
"birthdate": "2025-11-07T18:33:43.2308718+00:00",
"create_date": "2025-11-07T18:33:43.2308718+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-11-07T18:33:43.2308718+00:00"
},
"modified_dateutc": "2025-11-07T18:33:43.2308718+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": "0e1a1328-a45a-4bae-bbd0-cbbba76376ff",
"_parent_id": "196f5b1a-7b1b-4e33-bc8b-bcfa2de6ac0c",
"_parent_reference_back_office": "sample string 3",
"project_status_id": "e8ef2fd0-ba0d-4676-9f1a-24696d4c2ba1",
"company_id": "f6d3001d-2e81-4aee-aeed-cb2d834ca56e",
"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": "eeab8f3d-b58d-47e0-8d99-f39e68d04467",
"db_country_code": "sample string 17",
"street2": "sample string 18",
"latitude_decimal": 1.0,
"longitude_decimal": 1.0,
"contact_id": "35e8fa2d-e377-4110-84f8-b2d6543135fa",
"contact_reference_back_office": "sample string 20",
"contact": {
"id": "a56dca4a-13fe-4ee9-8d00-61886d0944ad",
"firstname": "sample string 2",
"lastname": "sample string 3",
"company_id": "8be312c8-a9b5-4a2e-b3e9-f0de755efeb1",
"company_code": "sample string 5",
"company": {
"id": "ffdf6f5b-8452-4703-8f54-c5e97a9c265f",
"is_client": true,
"is_supplier": true,
"archived": true,
"name": "sample string 5",
"notes": "sample string 6",
"create_date": "2025-11-07T18:33:43.2464993+00:00",
"sales_territory_id": "2ca255d1-1de0-4b3f-bad1-93f0dd65784e",
"sales_territory_code": "sample string 9",
"sales_territory": {
"id": "65381371-021f-48ae-9c08-c357db3e6590",
"code": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "cb99c664-a62f-45d2-92cd-7de8123f8ac4",
"sales_organization_code": "sample string 5",
"sales_organization": {
"id": "74dcaace-d913-412c-af6e-94024b4436af",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "e4183679-53f4-41e1-af95-b275181b4050",
"db_currency_id": "1b4b2772-17c2-481f-b51b-b37d30fbdecf",
"db_language_id": "d5252e58-317d-4684-81a7-eff3d9c00805",
"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-11-07T18:33:43.2464993+00:00"
},
"modified_dateutc": "2025-11-07T18:33:43.2464993+00:00"
},
"marketing_segment_id": "61cdf147-f67f-4175-85a1-98c857c29449",
"marketing_segment_code": "sample string 11",
"sales_organization_id": "aeceaaf7-eb0d-4b7c-906e-ba2599911ea0",
"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": "ebed9a08-ab56-4aad-8e29-2609f72ef623",
"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": "3c9b3716-d5cb-4e7c-9f19-83978ad71927",
"db_country_code": "sample string 28",
"feelist_id": "1597309e-ff5c-4455-902b-3ec728ff0a8a",
"feelist_reference_back_office": "sample string 30",
"feelist": {
"id": "a7f1f9a6-d9f9-45d8-921e-d665cda7cfbe",
"name": "sample string 2",
"description": "sample string 3",
"is_default": true,
"default_price": 1.0,
"sales_organization_id": "895d3f94-975a-43a2-a8ed-74e75d6e820c",
"sales_organization_code": "sample string 6",
"reference_back_office": "sample string 7",
"modified_dateutc": "2025-11-07T18:33:43.2464993+00:00",
"db_currency_id": "96c8af0d-4aff-4ef6-b487-7326b8d9c38f",
"db_currency_code": "sample string 10"
},
"company_type_id": "15501f13-595b-4965-8f1a-c15c6a73b2e7",
"company_type_name": "sample string 32",
"company_type": {
"id": "97c78e6e-b712-4404-ac73-457ab04f37c4",
"name": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "c46d052a-942f-4b78-afba-edf27e956a4e",
"sales_organization_code": "sample string 5"
},
"db_language_id": "0352a8b2-ea84-4e1f-be18-92f747d6971e",
"db_language_code": "sample string 34",
"code": "sample string 35",
"article_price_label_id": "bece0974-bce9-4f8f-a1b2-6bd20fcb653f",
"article_price_label_code": "sample string 37",
"db_payment_method_id": "c74e9ab9-ba9e-4bcc-81b7-b72a0a11f670",
"db_payment_method_reference_back_office": "sample string 39",
"db_payment_methods": {
"id": "b08668a6-4785-4028-95f9-07ab67854a04",
"name": "sample string 2",
"description": "sample string 3",
"reference_back_office": "sample string 4",
"activated": true,
"modified_dateutc": "2025-11-07T18:33:43.2464993+00:00"
},
"company_sector_id": "642b85d9-32c2-4360-9d7a-5c5eda1d2707",
"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": "f78581c7-af70-4af1-88b0-54587367a5a4",
"service_manager_user_code": "sample string 52",
"finance_manager_user_id": "d349ac28-9d96-430f-8bd2-c84f6e732ce3",
"finance_manager_user_code": "sample string 54",
"account_manager_user_id": "26091fca-dc19-4c86-bc89-282f1c0c461d",
"account_manager_user_code": "sample string 56",
"company_status_id": "10daf4ad-399f-4572-82dd-c8d033f99dfc",
"invoice_email_to": "sample string 58",
"modified_dateutc": "2025-11-07T18:33:43.2464993+00:00",
"id2": 60
},
"db_language_id": "ee0e5efb-d95a-4992-83a4-afa7f760a876",
"db_language_code": "sample string 7",
"db_title_id": "6506bb3c-4fed-4aac-987f-665d86b97071",
"archived": true,
"functions": "sample string 10",
"e_login": "sample string 11",
"e_password": "sample string 12",
"notes": "sample string 13",
"birthdate": "2025-11-07T18:33:43.2464993+00:00",
"create_date": "2025-11-07T18:33:43.2464993+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-11-07T18:33:43.2464993+00:00"
},
"modified_dateutc": "2025-11-07T18:33:43.2464993+00:00",
"id2": 22
}