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": "a0423145-226e-4792-b0f4-3ee810268e4a",
"_parent_id": "ba911e55-9992-483d-999c-dec8b45f84f8",
"_parent_reference_back_office": "sample string 3",
"project_status_id": "1b213870-46f7-4a8f-b24c-ae0b102cbfcf",
"company_id": "81280c39-fd48-4f56-8a5f-d89c1d7126a0",
"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": "8b27750b-ef95-433c-a714-1b3659e6f1fa",
"db_country_code": "sample string 17",
"street2": "sample string 18",
"latitude_decimal": 1.0,
"longitude_decimal": 1.0,
"contact_id": "d01e7dd7-242e-4c3f-a4ea-4e638ad5fc2f",
"contact_reference_back_office": "sample string 20",
"contact": {
"id": "0c695852-d5b4-414a-a371-7090b01e4fde",
"firstname": "sample string 2",
"lastname": "sample string 3",
"company_id": "9a8cf6b9-50ce-43af-8f91-b4802940d262",
"company_code": "sample string 5",
"company": {
"id": "12f0caab-6f34-4aee-bd0c-dce55ed9629f",
"is_client": true,
"is_supplier": true,
"archived": true,
"name": "sample string 5",
"notes": "sample string 6",
"create_date": "2026-11-12T15:26:13.0889753+00:00",
"sales_territory_id": "53f95bb6-fa7f-4022-8a59-1f9fb7a576ef",
"sales_territory_code": "sample string 9",
"sales_territory": {
"id": "4bf03a9c-69eb-43e4-9833-806ae7b164f4",
"code": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "b9e64b92-7178-4e2b-8b51-60322a8dc7df",
"sales_organization_code": "sample string 5",
"sales_organization": {
"id": "66ce41d3-e483-4e5b-ba50-31cb08148c9e",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "34a60040-7843-4cca-b933-1565f5d5546a",
"db_currency_id": "b32963e0-f6a0-462f-bf44-78b8225740fa",
"db_language_id": "385dd49b-d393-415e-980a-83f4e3fea6d0",
"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-11-12T15:26:13.0889753+00:00"
},
"modified_dateutc": "2026-11-12T15:26:13.0889753+00:00"
},
"marketing_segment_id": "6a7567b6-513c-4c5c-bcf8-fdb8c9d85c9f",
"marketing_segment_code": "sample string 11",
"sales_organization_id": "a45e9287-f302-4114-8892-daa3416e295b",
"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": "0f0bc45b-c03c-41ae-9431-5449dbfcdd24",
"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": "5158d844-c78c-4c13-8301-3a087207e371",
"db_country_code": "sample string 28",
"feelist_id": "6c4287a7-52f5-4802-984f-30b020610ac1",
"feelist_reference_back_office": "sample string 30",
"feelist": {
"id": "130a7d2f-b192-4e86-bc12-eed4e4dd5197",
"name": "sample string 2",
"description": "sample string 3",
"is_default": true,
"default_price": 1.0,
"sales_organization_id": "723ed237-9f85-4fd9-bbdf-7d1ed3e45680",
"sales_organization_code": "sample string 6",
"reference_back_office": "sample string 7",
"modified_dateutc": "2026-11-12T15:26:13.0889753+00:00",
"db_currency_id": "248ec243-6c2d-442b-8456-0ee30386788b",
"db_currency_code": "sample string 10"
},
"company_type_id": "de7c2cee-8880-46ac-a230-446c7be01213",
"company_type_name": "sample string 32",
"company_type": {
"id": "8c422318-89eb-4fee-85f2-8777f477184c",
"name": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "fa232798-8da9-4167-b691-314a57f9af1b",
"sales_organization_code": "sample string 5"
},
"db_language_id": "a15a1995-dbaf-43a4-9da6-f878346740cd",
"db_language_code": "sample string 34",
"code": "sample string 35",
"article_price_label_id": "e9755bb5-34c3-477e-bb68-af61377bae5c",
"article_price_label_code": "sample string 37",
"db_payment_method_id": "7b0f9c01-8b50-45a3-998b-c48026e6c2fe",
"db_payment_method_reference_back_office": "sample string 39",
"db_payment_methods": {
"id": "f661b084-f8c8-4f34-bd30-f9d4e1efef4d",
"name": "sample string 2",
"description": "sample string 3",
"reference_back_office": "sample string 4",
"activated": true,
"modified_dateutc": "2026-11-12T15:26:13.0889753+00:00"
},
"company_sector_id": "b3c11c92-386f-4359-8420-945192ed5781",
"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": "57966205-5d06-4b07-9708-75709902a308",
"service_manager_user_code": "sample string 52",
"finance_manager_user_id": "6f89bb14-3d1c-4104-b272-c884c9ef858c",
"finance_manager_user_code": "sample string 54",
"account_manager_user_id": "e8e6a8d5-4a6f-4c51-bafa-4f44ea875a0f",
"account_manager_user_code": "sample string 56",
"company_status_id": "c829cb1b-eef6-493c-a977-f2de4624037e",
"invoice_email_to": "sample string 58",
"modified_dateutc": "2026-11-12T15:26:13.0889753+00:00",
"id2": 60
},
"db_language_id": "c1ea855e-bf46-4c54-a318-e7dea43dc0be",
"db_language_code": "sample string 7",
"db_title_id": "8f3b27d2-bcd5-4742-ae1b-d513215fa0a7",
"archived": true,
"functions": "sample string 10",
"e_login": "sample string 11",
"e_password": "sample string 12",
"notes": "sample string 13",
"birthdate": "2026-11-12T15:26:13.0889753+00:00",
"create_date": "2026-11-12T15:26:13.0889753+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-11-12T15:26:13.0889753+00:00"
},
"modified_dateutc": "2026-11-12T15:26:13.0889753+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": "3b06c2ce-7d80-4beb-9418-78b02370699e",
"_parent_id": "7937d633-49be-47ff-8a33-1b2aa4b256b4",
"_parent_reference_back_office": "sample string 3",
"project_status_id": "8d759fc2-e452-4b9e-bda8-3397a22168fa",
"company_id": "529dd3a6-b2cf-4e74-a75f-1bdfbc870331",
"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": "ce99d2c4-5ba7-4509-8517-b646e328eb28",
"db_country_code": "sample string 17",
"street2": "sample string 18",
"latitude_decimal": 1.0,
"longitude_decimal": 1.0,
"contact_id": "318e1b87-3ba1-49c9-9640-377c8f21b8d9",
"contact_reference_back_office": "sample string 20",
"contact": {
"id": "06513e91-2ae8-4944-88af-1b1ae9741776",
"firstname": "sample string 2",
"lastname": "sample string 3",
"company_id": "884a68af-38f8-42af-aa3c-85e32da1cada",
"company_code": "sample string 5",
"company": {
"id": "4baddff4-b978-4a36-89b8-f22c4638ebb2",
"is_client": true,
"is_supplier": true,
"archived": true,
"name": "sample string 5",
"notes": "sample string 6",
"create_date": "2026-11-12T15:26:13.1075048+00:00",
"sales_territory_id": "eb62ccc2-b221-40f9-ba65-8c4873745896",
"sales_territory_code": "sample string 9",
"sales_territory": {
"id": "42e5bf85-028f-47f0-a91f-5f829ffc1465",
"code": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "21a901b4-7e6f-40e5-b654-b415c667b7de",
"sales_organization_code": "sample string 5",
"sales_organization": {
"id": "210259ca-da42-4315-87ae-f67ff86181c2",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "cb095a42-2ede-468a-8809-8f6e1b720d21",
"db_currency_id": "b9a374c6-db05-4635-8982-dc8c591ac7c3",
"db_language_id": "6c2289e1-31aa-4466-86fd-a33ddf258bd7",
"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-11-12T15:26:13.1075048+00:00"
},
"modified_dateutc": "2026-11-12T15:26:13.1075048+00:00"
},
"marketing_segment_id": "0439c0d0-1eee-4462-8d62-5932bda0b485",
"marketing_segment_code": "sample string 11",
"sales_organization_id": "1c3232c2-f45e-463f-ae83-3326cedc5d3d",
"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": "c8acdc91-c955-466c-8917-45588a82f5b7",
"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": "1d5c6919-ccbd-4395-8fab-723e8039ce6d",
"db_country_code": "sample string 28",
"feelist_id": "c94f8253-f8ef-407d-a508-3eae924c4a61",
"feelist_reference_back_office": "sample string 30",
"feelist": {
"id": "1295d39a-337c-451a-b98e-57c4f86b4eaa",
"name": "sample string 2",
"description": "sample string 3",
"is_default": true,
"default_price": 1.0,
"sales_organization_id": "49c9c000-5b0f-43cf-8bdb-5bd06dd67c03",
"sales_organization_code": "sample string 6",
"reference_back_office": "sample string 7",
"modified_dateutc": "2026-11-12T15:26:13.1075048+00:00",
"db_currency_id": "a0e4aece-bb37-4891-823b-f38fd6604c4a",
"db_currency_code": "sample string 10"
},
"company_type_id": "26126c01-c4f6-4f73-8dd7-3182f0d1fd0c",
"company_type_name": "sample string 32",
"company_type": {
"id": "ddd730c9-80c9-4585-a75c-79f6934a97ea",
"name": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "7c11a3b1-2a88-46a4-a7a9-81aff5e53418",
"sales_organization_code": "sample string 5"
},
"db_language_id": "9d67ce3f-e0c0-4047-8fb4-872d57d02bbe",
"db_language_code": "sample string 34",
"code": "sample string 35",
"article_price_label_id": "18168e36-4146-482f-95a9-c7c5a9bb9084",
"article_price_label_code": "sample string 37",
"db_payment_method_id": "a77fc9e4-0035-45ea-97d0-7034361731cc",
"db_payment_method_reference_back_office": "sample string 39",
"db_payment_methods": {
"id": "182160d6-43b1-49be-b783-17211e911466",
"name": "sample string 2",
"description": "sample string 3",
"reference_back_office": "sample string 4",
"activated": true,
"modified_dateutc": "2026-11-12T15:26:13.1075048+00:00"
},
"company_sector_id": "96a9ec7e-ea22-47d9-a325-43bcf11300fe",
"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": "48793f5d-2aca-47be-9ec4-51593917c244",
"service_manager_user_code": "sample string 52",
"finance_manager_user_id": "f24d463b-426d-478d-a4e8-54cba9a0361b",
"finance_manager_user_code": "sample string 54",
"account_manager_user_id": "e58139e9-d58e-411d-9fce-1a53d1b70d33",
"account_manager_user_code": "sample string 56",
"company_status_id": "fa485764-8928-4547-afbb-8f8b383ef88a",
"invoice_email_to": "sample string 58",
"modified_dateutc": "2026-11-12T15:26:13.1075048+00:00",
"id2": 60
},
"db_language_id": "7c22d6d2-67e3-4d2a-b70e-98e41dae4d44",
"db_language_code": "sample string 7",
"db_title_id": "8d77d579-e7a6-4e3f-995d-eab300fb8d7e",
"archived": true,
"functions": "sample string 10",
"e_login": "sample string 11",
"e_password": "sample string 12",
"notes": "sample string 13",
"birthdate": "2026-11-12T15:26:13.1075048+00:00",
"create_date": "2026-11-12T15:26:13.1075048+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-11-12T15:26:13.1075048+00:00"
},
"modified_dateutc": "2026-11-12T15:26:13.1075048+00:00",
"id2": 22
}