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": "fc28f336-c225-4f9e-8e01-e3768d4576da",
"_parent_id": "4185fddc-04c1-4abf-a9a4-a2609c67f3a3",
"_parent_reference_back_office": "sample string 3",
"project_status_id": "e2812f4d-e7e9-4fa3-8a86-a754b6af3086",
"company_id": "f46a0368-d9c2-414b-9dd5-016f6b2b614b",
"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": "10924a95-998f-4b3f-bf6c-38c5b0dd4a4f",
"db_country_code": "sample string 17",
"street2": "sample string 18",
"latitude_decimal": 1.0,
"longitude_decimal": 1.0,
"contact_id": "b3a62c74-fb3d-4d21-968b-8051586e092a",
"contact_reference_back_office": "sample string 20",
"contact": {
"id": "e234f066-95e6-4743-89c8-23762a4bd062",
"firstname": "sample string 2",
"lastname": "sample string 3",
"company_id": "d51d732a-7743-43c9-8f38-d8a349444e3d",
"company_code": "sample string 5",
"company": {
"id": "7b18aada-2328-4c39-bb92-9a1c160659eb",
"is_client": true,
"is_supplier": true,
"archived": true,
"name": "sample string 5",
"notes": "sample string 6",
"create_date": "2026-10-12T17:52:34.5552832+00:00",
"sales_territory_id": "7751e470-567c-4a63-9c1f-8ba86e05d036",
"sales_territory_code": "sample string 9",
"sales_territory": {
"id": "06558a2d-57e5-4885-82d7-91acab15c553",
"code": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "0237896a-e41e-4c08-85da-1de9ae832641",
"sales_organization_code": "sample string 5",
"sales_organization": {
"id": "ab77b9d0-2c32-47c3-875a-5f87f43ca07b",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "957aae83-485b-43a3-ac6e-9cd6757869f3",
"db_currency_id": "83248822-f69a-49f3-9749-0f9121deba50",
"db_language_id": "8a734475-989a-4823-94dc-e0b36d1b6da7",
"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-10-12T17:52:34.5552832+00:00"
},
"modified_dateutc": "2026-10-12T17:52:34.5552832+00:00"
},
"marketing_segment_id": "22737b00-52e6-4a93-bb35-d9dd728ff240",
"marketing_segment_code": "sample string 11",
"sales_organization_id": "4c680ed6-053d-4dc4-a9ad-ce759c74b378",
"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": "85865ca9-e5ca-4c29-bfec-99b4b6ecd13a",
"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": "3d451fbb-c7f6-4968-beab-f9b6eeddcacc",
"db_country_code": "sample string 28",
"feelist_id": "ea23664f-5941-47e0-a2d9-6b1935fc76a4",
"feelist_reference_back_office": "sample string 30",
"feelist": {
"id": "5072b4f6-984d-4ab1-8fb4-1aab4ad2425d",
"name": "sample string 2",
"description": "sample string 3",
"is_default": true,
"default_price": 1.0,
"sales_organization_id": "dbadb661-e2b0-49d2-a357-6d77b08b057f",
"sales_organization_code": "sample string 6",
"reference_back_office": "sample string 7",
"modified_dateutc": "2026-10-12T17:52:34.5552832+00:00",
"db_currency_id": "30b7895c-c70d-4326-9974-a9822bac4ed2",
"db_currency_code": "sample string 10"
},
"company_type_id": "c1ee4255-1b42-4104-ac36-a1c89044b0a0",
"company_type_name": "sample string 32",
"company_type": {
"id": "b8ec00f8-7448-443b-82bf-5e8ab842d4d0",
"name": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "b39cc6fa-f660-4f04-a7a9-4b0a3228c342",
"sales_organization_code": "sample string 5"
},
"db_language_id": "ccdce0fe-c700-4c24-87d2-78a03b13f68e",
"db_language_code": "sample string 34",
"code": "sample string 35",
"article_price_label_id": "dc4d0a0e-a6ad-4597-b7f7-9ff183100805",
"article_price_label_code": "sample string 37",
"db_payment_method_id": "f54f6a29-13f0-45cb-8c72-fc48945b2e21",
"db_payment_method_reference_back_office": "sample string 39",
"db_payment_methods": {
"id": "1b062492-78ad-41e7-a280-8763493c8c00",
"name": "sample string 2",
"description": "sample string 3",
"reference_back_office": "sample string 4",
"activated": true,
"modified_dateutc": "2026-10-12T17:52:34.5552832+00:00"
},
"company_sector_id": "f625c0da-7321-4fb5-a2c8-d1c038ba0c73",
"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": "b75b0f7e-e5d6-4070-a4c5-fd6e51a8e98d",
"service_manager_user_code": "sample string 52",
"finance_manager_user_id": "c430d6f7-f233-4182-b704-a6eb9f90acb2",
"finance_manager_user_code": "sample string 54",
"account_manager_user_id": "9294b8ae-000f-493b-8376-51c1887b823f",
"account_manager_user_code": "sample string 56",
"company_status_id": "f8c62a21-cc7c-4938-86ce-5bf3289c3907",
"invoice_email_to": "sample string 58",
"modified_dateutc": "2026-10-12T17:52:34.5552832+00:00",
"id2": 60
},
"db_language_id": "5b51fcde-fc07-401d-8fa3-f8316ec9c3e9",
"db_language_code": "sample string 7",
"db_title_id": "9b7f47bb-6030-40fa-b474-3a90aae77c78",
"archived": true,
"functions": "sample string 10",
"e_login": "sample string 11",
"e_password": "sample string 12",
"notes": "sample string 13",
"birthdate": "2026-10-12T17:52:34.5552832+00:00",
"create_date": "2026-10-12T17:52:34.5552832+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-10-12T17:52:34.5552832+00:00"
},
"modified_dateutc": "2026-10-12T17:52:34.5552832+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": "5885fce3-fc2f-4168-951d-401bad1613ca",
"_parent_id": "29cf893e-3e40-489a-82bd-49f09abc7ef2",
"_parent_reference_back_office": "sample string 3",
"project_status_id": "4c786c48-2747-479a-ae0d-10cc311830fa",
"company_id": "bdbb2a02-209c-4d6a-a013-5a2395b40e5b",
"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": "89e89247-31c4-4dde-91db-d1c906d42239",
"db_country_code": "sample string 17",
"street2": "sample string 18",
"latitude_decimal": 1.0,
"longitude_decimal": 1.0,
"contact_id": "62b42332-d232-4cbe-8e07-a68ffeb622b7",
"contact_reference_back_office": "sample string 20",
"contact": {
"id": "bddc9fee-44d7-4d11-b461-ead9abe0b81e",
"firstname": "sample string 2",
"lastname": "sample string 3",
"company_id": "8e1e694e-2009-48f1-9f15-9436873eb7cc",
"company_code": "sample string 5",
"company": {
"id": "f371dc18-d4c8-494d-ae20-2efc9d4483cf",
"is_client": true,
"is_supplier": true,
"archived": true,
"name": "sample string 5",
"notes": "sample string 6",
"create_date": "2026-10-12T17:52:34.6210514+00:00",
"sales_territory_id": "0a472ee9-d660-4a64-8d89-f0d571c5efe1",
"sales_territory_code": "sample string 9",
"sales_territory": {
"id": "bdf05b2b-4327-408c-96f5-9e5ce078b1b0",
"code": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "7c8d6806-dc75-4fb6-b50a-9d6a6c8882f9",
"sales_organization_code": "sample string 5",
"sales_organization": {
"id": "b7692aa8-fb07-41d1-918d-aadd1ccff83b",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "6b6ca60d-e3d0-4813-abc9-3722fc073e18",
"db_currency_id": "708a79ed-feec-47c6-a332-ac25b19db32c",
"db_language_id": "de1ec093-4318-451d-bf47-03ea8d956255",
"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-10-12T17:52:34.6210514+00:00"
},
"modified_dateutc": "2026-10-12T17:52:34.6210514+00:00"
},
"marketing_segment_id": "72394189-bba4-46ee-a876-9a506e95f9ec",
"marketing_segment_code": "sample string 11",
"sales_organization_id": "4db2c1af-f743-4d42-b44f-66f6e51b715f",
"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": "68923bff-75e9-4cdb-a7c6-99249cf1fad6",
"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": "eea9ffbf-3734-42bf-a7c9-1609bde4aa5d",
"db_country_code": "sample string 28",
"feelist_id": "53102083-d8f3-4363-9e0c-3926f3488865",
"feelist_reference_back_office": "sample string 30",
"feelist": {
"id": "ae73f965-7d5c-445f-98e1-2e2b14e8b257",
"name": "sample string 2",
"description": "sample string 3",
"is_default": true,
"default_price": 1.0,
"sales_organization_id": "49ae6fb2-d02d-4899-82ea-8ac522b70a90",
"sales_organization_code": "sample string 6",
"reference_back_office": "sample string 7",
"modified_dateutc": "2026-10-12T17:52:34.6210514+00:00",
"db_currency_id": "a9c716b4-cacb-46b2-9868-d95ef3ea68bf",
"db_currency_code": "sample string 10"
},
"company_type_id": "e4b7e8f6-1e16-40c6-a2f1-66e858eb91c3",
"company_type_name": "sample string 32",
"company_type": {
"id": "f5b74cc2-0730-4fe6-972b-ff283bb6cbca",
"name": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "66fd1d3f-14c4-45ab-a93d-181a63a14541",
"sales_organization_code": "sample string 5"
},
"db_language_id": "e3dfd782-2ee7-4dc0-8f2a-1aad4677fde5",
"db_language_code": "sample string 34",
"code": "sample string 35",
"article_price_label_id": "3ac0cbf4-7ed7-46b7-981d-3393fa56235b",
"article_price_label_code": "sample string 37",
"db_payment_method_id": "8f861cc9-ec10-472c-b712-8014e938b08a",
"db_payment_method_reference_back_office": "sample string 39",
"db_payment_methods": {
"id": "848ce7db-c8bc-4690-920a-af9e870e59cb",
"name": "sample string 2",
"description": "sample string 3",
"reference_back_office": "sample string 4",
"activated": true,
"modified_dateutc": "2026-10-12T17:52:34.6210514+00:00"
},
"company_sector_id": "7bb9b2c7-8e58-474e-b7ac-dc7ec1373f68",
"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": "9bec345f-703c-486e-841c-64ec981b9451",
"service_manager_user_code": "sample string 52",
"finance_manager_user_id": "cff3ec08-9547-4eb6-a1f3-b52e884a1f4d",
"finance_manager_user_code": "sample string 54",
"account_manager_user_id": "a27e6198-e4bc-4fb5-807b-b44734c352a5",
"account_manager_user_code": "sample string 56",
"company_status_id": "75287959-b6e7-4faf-bb7c-c74a99623337",
"invoice_email_to": "sample string 58",
"modified_dateutc": "2026-10-12T17:52:34.6210514+00:00",
"id2": 60
},
"db_language_id": "175d1834-453d-41fe-b437-9e12b9bfd524",
"db_language_code": "sample string 7",
"db_title_id": "341dce04-0dfd-4e9b-9f0a-7cfb745de51e",
"archived": true,
"functions": "sample string 10",
"e_login": "sample string 11",
"e_password": "sample string 12",
"notes": "sample string 13",
"birthdate": "2026-10-12T17:52:34.6333742+00:00",
"create_date": "2026-10-12T17:52:34.6333742+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-10-12T17:52:34.6333742+00:00"
},
"modified_dateutc": "2026-10-12T17:52:34.6333742+00:00",
"id2": 22
}