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": "9d9c0c21-61ab-4daf-8f99-187626f7da98",
"_parent_id": "0ae1633a-77be-4b3b-9b93-478f1a5e3971",
"_parent_reference_back_office": "sample string 3",
"project_status_id": "46c6ee31-3427-4802-98c8-e39abff7d03f",
"company_id": "1d667b2e-fe37-416c-a51d-90de0f2120c5",
"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": "2ed71ec8-19da-431c-bfa4-8b01a7adcf92",
"db_country_code": "sample string 17",
"street2": "sample string 18",
"latitude_decimal": 1.0,
"longitude_decimal": 1.0,
"contact_id": "d2cbbe6e-a1f7-428b-89e2-6d865f5678ef",
"contact_reference_back_office": "sample string 20",
"contact": {
"id": "b243b826-9f94-4385-89fa-fa66e5f00070",
"firstname": "sample string 2",
"lastname": "sample string 3",
"company_id": "71152d76-561b-4fe6-987f-9f32ae25d3ad",
"company_code": "sample string 5",
"company": {
"id": "4b69dea1-a464-45a9-b47a-7a1f1a305d66",
"is_client": true,
"is_supplier": true,
"archived": true,
"name": "sample string 5",
"notes": "sample string 6",
"create_date": "2025-10-12T21:22:39.6297703+00:00",
"sales_territory_id": "db5d6ea8-7e74-43d6-91a3-ced0e41dc20f",
"sales_territory_code": "sample string 9",
"sales_territory": {
"id": "f6248b4c-0410-432f-a6fc-6be329f05cbd",
"code": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "7fd67ae3-f664-4577-8358-1b6d5f810b16",
"sales_organization_code": "sample string 5",
"sales_organization": {
"id": "671e8918-0439-4d06-836f-74fcdfa7d3f5",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "a239cb71-7837-45b4-9181-83dc36e1a7f4",
"db_currency_id": "9ad87f18-5fa6-4592-89da-d976fd81bceb",
"db_language_id": "17919394-59e5-413d-9e84-d442238a1b4f",
"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-10-12T21:22:39.6297703+00:00"
},
"modified_dateutc": "2025-10-12T21:22:39.6297703+00:00"
},
"marketing_segment_id": "5b50a6f3-f92a-4fee-ba7b-03ee9a941898",
"marketing_segment_code": "sample string 11",
"sales_organization_id": "4a1657c3-6e52-4029-b55f-aa3d44fee725",
"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": "a9f5bc88-f958-4e46-84fe-0cc0f3a1c2b5",
"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": "94ac16ba-af74-496b-be09-84995aa8d05d",
"db_country_code": "sample string 28",
"feelist_id": "b748024d-c1b4-4b53-ac32-8338861d884b",
"feelist_reference_back_office": "sample string 30",
"feelist": {
"id": "45febe31-6f1a-40ee-af77-c94cbee70b54",
"name": "sample string 2",
"description": "sample string 3",
"is_default": true,
"default_price": 1.0,
"sales_organization_id": "06ceaf9d-b651-4881-a67a-318f74751222",
"sales_organization_code": "sample string 6",
"reference_back_office": "sample string 7",
"modified_dateutc": "2025-10-12T21:22:39.6297703+00:00",
"db_currency_id": "e8ff5d2e-e79a-40e5-a2e3-3018d72391ec",
"db_currency_code": "sample string 10"
},
"company_type_id": "18a82d5b-9bbe-4682-ae5e-4a38e591a9d8",
"company_type_name": "sample string 32",
"company_type": {
"id": "0e6c4018-b7cc-4adb-9f7e-ad8cb56e05eb",
"name": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "5a333050-5266-4476-8eba-1a274e008e00",
"sales_organization_code": "sample string 5"
},
"db_language_id": "156eb3be-861b-447f-9b3d-31adfd01b5f4",
"db_language_code": "sample string 34",
"code": "sample string 35",
"article_price_label_id": "5361a919-03e1-4a03-be70-afcd5213c14c",
"article_price_label_code": "sample string 37",
"db_payment_method_id": "644f8ba2-e339-4c0c-aca8-47a64b0fac3f",
"db_payment_method_reference_back_office": "sample string 39",
"db_payment_methods": {
"id": "7db4a1a7-74a7-420b-89c0-7470ce2062f8",
"name": "sample string 2",
"description": "sample string 3",
"reference_back_office": "sample string 4",
"activated": true,
"modified_dateutc": "2025-10-12T21:22:39.6297703+00:00"
},
"company_sector_id": "88ff36cb-94dc-4565-9ed3-1e06993cbec8",
"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": "5cb2260d-7ccd-448d-8807-94c724ccb6ec",
"service_manager_user_code": "sample string 52",
"finance_manager_user_id": "684ba149-67d1-4fe2-8952-9f92cc7fc18b",
"finance_manager_user_code": "sample string 54",
"account_manager_user_id": "affbc3e9-e1db-46a2-ada5-332b4071d26c",
"account_manager_user_code": "sample string 56",
"company_status_id": "753cf7a1-8d0b-4ada-b39a-2847d1dd78bd",
"invoice_email_to": "sample string 58",
"modified_dateutc": "2025-10-12T21:22:39.6297703+00:00",
"id2": 60
},
"db_language_id": "0460ac75-938d-4558-9284-d30dec3c4335",
"db_language_code": "sample string 7",
"db_title_id": "3e03ff25-ee13-49a9-8faa-e4948a685146",
"archived": true,
"functions": "sample string 10",
"e_login": "sample string 11",
"e_password": "sample string 12",
"notes": "sample string 13",
"birthdate": "2025-10-12T21:22:39.6297703+00:00",
"create_date": "2025-10-12T21:22:39.6297703+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-10-12T21:22:39.6297703+00:00"
},
"modified_dateutc": "2025-10-12T21:22:39.6297703+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": "70b9fa8a-efb2-4903-9c6f-4dd7068a360e",
"_parent_id": "f3298079-f926-4e96-be30-95b135c735f6",
"_parent_reference_back_office": "sample string 3",
"project_status_id": "cc964d75-d5d4-4e1c-bd53-5d5c08e2c8c5",
"company_id": "5bbc85b9-d4a5-44bb-a4f3-5861b2ead821",
"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": "4695e7c7-6c2b-4859-a364-1ea207d5f401",
"db_country_code": "sample string 17",
"street2": "sample string 18",
"latitude_decimal": 1.0,
"longitude_decimal": 1.0,
"contact_id": "5eb1bae8-85f5-43ca-bdaf-8d08171c645e",
"contact_reference_back_office": "sample string 20",
"contact": {
"id": "296e8259-43ae-4ea5-a2d5-feb18f70dd4e",
"firstname": "sample string 2",
"lastname": "sample string 3",
"company_id": "93d6d28f-9c68-4d70-bfaf-c60aeee7f7e3",
"company_code": "sample string 5",
"company": {
"id": "e881b978-1f0f-4ad0-9a65-e9c83699a9c5",
"is_client": true,
"is_supplier": true,
"archived": true,
"name": "sample string 5",
"notes": "sample string 6",
"create_date": "2025-10-12T21:22:39.6297703+00:00",
"sales_territory_id": "1a1a5978-72e5-432d-97fa-e6d614baeb86",
"sales_territory_code": "sample string 9",
"sales_territory": {
"id": "3c5a1b17-c46d-4ed6-a518-d67405b8dad5",
"code": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "7a869a49-5b2d-4e18-b4e9-b8cb11cae544",
"sales_organization_code": "sample string 5",
"sales_organization": {
"id": "31bbb0ff-d60d-4d3f-bbbb-189aebb5795d",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "2719d06b-c120-4ec3-983e-43b670d019fe",
"db_currency_id": "5d4c322a-ab98-4170-8e92-6c90340a8527",
"db_language_id": "20d562f1-99d1-4cdf-bdee-a58d3e5cdc10",
"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-10-12T21:22:39.6297703+00:00"
},
"modified_dateutc": "2025-10-12T21:22:39.6297703+00:00"
},
"marketing_segment_id": "552c9930-9033-4ab4-8bcb-070f14ca5263",
"marketing_segment_code": "sample string 11",
"sales_organization_id": "4e332b4d-f155-4d8a-8bd1-ea4cce808690",
"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": "4c8b1c14-0dae-4155-b67e-3b547e8e7f96",
"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": "8e20b11d-133d-4bbd-9e22-3ceb7893b521",
"db_country_code": "sample string 28",
"feelist_id": "2f811498-5209-4ace-89ad-19373ee25854",
"feelist_reference_back_office": "sample string 30",
"feelist": {
"id": "368f2ceb-07cd-444d-8b62-69e251d8da68",
"name": "sample string 2",
"description": "sample string 3",
"is_default": true,
"default_price": 1.0,
"sales_organization_id": "0e54cb7e-f181-4cfb-a8af-108c978c5487",
"sales_organization_code": "sample string 6",
"reference_back_office": "sample string 7",
"modified_dateutc": "2025-10-12T21:22:39.6297703+00:00",
"db_currency_id": "916fc49e-bc34-4299-b165-a102703b7ed7",
"db_currency_code": "sample string 10"
},
"company_type_id": "dd23d4e7-8cc0-42a1-9a5d-24fd33227713",
"company_type_name": "sample string 32",
"company_type": {
"id": "5bb4a85e-4c78-45e6-9474-d57d398e2ca0",
"name": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "144f71fc-140d-4072-a66c-aafb7d2623da",
"sales_organization_code": "sample string 5"
},
"db_language_id": "91e0793c-8b62-492d-a519-73c025341c2d",
"db_language_code": "sample string 34",
"code": "sample string 35",
"article_price_label_id": "2f91a815-fff3-42d9-815e-f076eb76a921",
"article_price_label_code": "sample string 37",
"db_payment_method_id": "692c1945-78f2-420a-8733-93506c5b509f",
"db_payment_method_reference_back_office": "sample string 39",
"db_payment_methods": {
"id": "14751213-1219-4190-a9bc-24683de1ef9f",
"name": "sample string 2",
"description": "sample string 3",
"reference_back_office": "sample string 4",
"activated": true,
"modified_dateutc": "2025-10-12T21:22:39.6297703+00:00"
},
"company_sector_id": "f645e1c5-ec0c-4f2e-86b1-e02bea7b54cd",
"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": "7f672f18-415b-41d9-a5e1-69f22faa1c9a",
"service_manager_user_code": "sample string 52",
"finance_manager_user_id": "c115ff4b-383c-4507-a7ec-63507142ae9b",
"finance_manager_user_code": "sample string 54",
"account_manager_user_id": "576f1dcf-f48f-4d23-8ffa-d1ab9a3af6e8",
"account_manager_user_code": "sample string 56",
"company_status_id": "28320d3c-fc8f-41e8-a3cd-ec1007c19cd9",
"invoice_email_to": "sample string 58",
"modified_dateutc": "2025-10-12T21:22:39.6297703+00:00",
"id2": 60
},
"db_language_id": "cbfe231b-6f70-4331-9a7d-9c55c66097f8",
"db_language_code": "sample string 7",
"db_title_id": "cf17e639-a283-43d9-bd5c-cf0938b000b7",
"archived": true,
"functions": "sample string 10",
"e_login": "sample string 11",
"e_password": "sample string 12",
"notes": "sample string 13",
"birthdate": "2025-10-12T21:22:39.6297703+00:00",
"create_date": "2025-10-12T21:22:39.6297703+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-10-12T21:22:39.6297703+00:00"
},
"modified_dateutc": "2025-10-12T21:22:39.6297703+00:00",
"id2": 22
}