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": "7f020f1c-96a5-4530-9ee3-3ede507cd678",
"_parent_id": "a4ef1f24-ad09-452b-b15f-8953c2e17888",
"_parent_reference_back_office": "sample string 3",
"project_status_id": "324db9e9-2611-49aa-bef3-06e5c8db4341",
"company_id": "b58613fc-48ee-4020-ad54-14de3ad4b6d5",
"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": "a022e012-06ca-4a9d-a4c0-547fa115a93d",
"db_country_code": "sample string 17",
"street2": "sample string 18",
"latitude_decimal": 1.0,
"longitude_decimal": 1.0,
"contact_id": "7931aef6-018d-4794-a617-17a60c706dcb",
"contact_reference_back_office": "sample string 20",
"contact": {
"id": "0c8c755c-cb42-4105-a2bf-cf78d1060d73",
"firstname": "sample string 2",
"lastname": "sample string 3",
"company_id": "04f1f41d-48f1-44ab-af8b-cbf465374103",
"company_code": "sample string 5",
"company": {
"id": "c90c3879-7c01-4e5e-8253-2be1fb3cd72e",
"is_client": true,
"is_supplier": true,
"archived": true,
"name": "sample string 5",
"notes": "sample string 6",
"create_date": "2026-08-21T18:59:15.2058761+00:00",
"sales_territory_id": "e4088e90-4082-41a0-9b01-502b3bb5cec4",
"sales_territory_code": "sample string 9",
"sales_territory": {
"id": "1837bae7-3d8d-4eb5-9791-c984ea8fa848",
"code": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "2626ead9-b6ea-46cb-be90-7a55aadfbc7c",
"sales_organization_code": "sample string 5",
"sales_organization": {
"id": "dfa10c0c-c54f-460f-8662-c2a99596831d",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "5ddea2c9-f436-46a5-a8db-4bf9ac279c33",
"db_currency_id": "5420419a-52b2-42cf-864b-f29b8bedbc40",
"db_language_id": "9f92cbd4-34e2-40cf-9669-052eb759bc7b",
"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-08-21T18:59:15.2058761+00:00"
},
"modified_dateutc": "2026-08-21T18:59:15.2058761+00:00"
},
"marketing_segment_id": "3a95df84-20bf-416c-819a-9b089e6ec85c",
"marketing_segment_code": "sample string 11",
"sales_organization_id": "eed33ad6-da4c-4a31-b2d0-79d387f6ae89",
"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": "dee83630-2f01-4adf-9fcb-e4e18998a9e2",
"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": "eb6642b7-afda-4cca-b1a1-ccde01f36353",
"db_country_code": "sample string 28",
"feelist_id": "f0ab5d1d-9288-4a2a-9ebe-552f26c8c2cc",
"feelist_reference_back_office": "sample string 30",
"feelist": {
"id": "639d1f43-0ee1-46ae-b381-aabfa3110e9a",
"name": "sample string 2",
"description": "sample string 3",
"is_default": true,
"default_price": 1.0,
"sales_organization_id": "f5f5c607-09b7-48d5-a293-81db2a45a817",
"sales_organization_code": "sample string 6",
"reference_back_office": "sample string 7",
"modified_dateutc": "2026-08-21T18:59:15.2058761+00:00",
"db_currency_id": "3be3b384-52b2-44a0-90c5-5a3260ffc87a",
"db_currency_code": "sample string 10"
},
"company_type_id": "6d6188d5-fb26-4215-b96b-c76519ecc740",
"company_type_name": "sample string 32",
"company_type": {
"id": "337d914b-c08d-4962-a133-18832166a6f3",
"name": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "829a0534-ec47-449b-9682-fe01cfccf832",
"sales_organization_code": "sample string 5"
},
"db_language_id": "09172ad8-207e-42d8-b669-14cddb352993",
"db_language_code": "sample string 34",
"code": "sample string 35",
"article_price_label_id": "c35e743f-19ec-44fd-8953-fb35e1434eff",
"article_price_label_code": "sample string 37",
"db_payment_method_id": "1e5f88a5-1920-4c74-9ad8-457070874855",
"db_payment_method_reference_back_office": "sample string 39",
"db_payment_methods": {
"id": "9ba8e1a8-c1d3-40e7-a57d-2af4e5de79cf",
"name": "sample string 2",
"description": "sample string 3",
"reference_back_office": "sample string 4",
"activated": true,
"modified_dateutc": "2026-08-21T18:59:15.2058761+00:00"
},
"company_sector_id": "44b4cc81-ecc7-408a-82df-6ade915af609",
"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": "a1400c83-cef0-46a9-9c9d-d3968643d644",
"service_manager_user_code": "sample string 52",
"finance_manager_user_id": "eeb51982-dedb-4f35-ae64-62d357f8058a",
"finance_manager_user_code": "sample string 54",
"account_manager_user_id": "05d6fb50-435b-493a-aac7-6561c3afcd4a",
"account_manager_user_code": "sample string 56",
"company_status_id": "c655a22e-c339-486f-9e40-6b6d23bb8ec1",
"invoice_email_to": "sample string 58",
"modified_dateutc": "2026-08-21T18:59:15.2058761+00:00",
"id2": 60
},
"db_language_id": "33f5e046-d34f-4a04-a9e2-0bc45b0c02a7",
"db_language_code": "sample string 7",
"db_title_id": "5cb7cae1-3700-49b9-aa53-cd74cd47867e",
"archived": true,
"functions": "sample string 10",
"e_login": "sample string 11",
"e_password": "sample string 12",
"notes": "sample string 13",
"birthdate": "2026-08-21T18:59:15.2058761+00:00",
"create_date": "2026-08-21T18:59:15.2058761+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-08-21T18:59:15.2058761+00:00"
},
"modified_dateutc": "2026-08-21T18:59:15.2058761+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": "1418b67c-4f7e-4f3d-aeeb-d23062ab4211",
"_parent_id": "5132399a-4979-4015-9c66-70cbd774720d",
"_parent_reference_back_office": "sample string 3",
"project_status_id": "36d18dfd-5c4e-4b39-8f76-8e78c769aaa9",
"company_id": "0111fab8-0957-4741-95e0-ea96aa4bd139",
"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": "acc3047c-fe3e-41de-9b41-b1b207c9dad9",
"db_country_code": "sample string 17",
"street2": "sample string 18",
"latitude_decimal": 1.0,
"longitude_decimal": 1.0,
"contact_id": "b16f4d13-6b75-4ebe-9fa2-d62d0d2ac323",
"contact_reference_back_office": "sample string 20",
"contact": {
"id": "ac5677a0-4996-452b-b9aa-bd7a92ce0ad4",
"firstname": "sample string 2",
"lastname": "sample string 3",
"company_id": "1a3ce79c-8e8f-4f6b-96dc-4d06118746af",
"company_code": "sample string 5",
"company": {
"id": "dce92ede-2e36-4dde-aee4-e8e4e3c7e442",
"is_client": true,
"is_supplier": true,
"archived": true,
"name": "sample string 5",
"notes": "sample string 6",
"create_date": "2026-08-21T18:59:15.2058761+00:00",
"sales_territory_id": "799f2d9f-cc18-4c4e-848a-cf30826ef73c",
"sales_territory_code": "sample string 9",
"sales_territory": {
"id": "b5a445c9-3de7-49ac-aa78-d096d813716c",
"code": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "41cd6174-1a59-4b48-af39-c246c0f573e1",
"sales_organization_code": "sample string 5",
"sales_organization": {
"id": "c4866f71-b9fb-41bf-ad50-cd619e624657",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "8eb3c6d4-143d-45d1-a7b7-77f0dddcc53d",
"db_currency_id": "8336368b-ed80-4f10-afe8-b37463957ce7",
"db_language_id": "11f1321d-3e67-443c-9a56-ea7cd9adefa9",
"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-08-21T18:59:15.2058761+00:00"
},
"modified_dateutc": "2026-08-21T18:59:15.2058761+00:00"
},
"marketing_segment_id": "dbed07e1-c7b4-4b96-990b-6a812a091c0d",
"marketing_segment_code": "sample string 11",
"sales_organization_id": "51fe6afe-3d2c-4d7a-b7fd-184e130bfafa",
"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": "bf1d9aad-f9a1-4467-a9da-e8d4bc44874d",
"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": "b9726508-7c98-46ff-a03e-d1dfd1792977",
"db_country_code": "sample string 28",
"feelist_id": "82e436f6-5fdc-4da6-a66d-e4ecccada983",
"feelist_reference_back_office": "sample string 30",
"feelist": {
"id": "b8f78262-48a1-4905-b2a1-bcbba6fcfcab",
"name": "sample string 2",
"description": "sample string 3",
"is_default": true,
"default_price": 1.0,
"sales_organization_id": "8a4b9b2e-47c5-44f1-bf68-4f09b99223ad",
"sales_organization_code": "sample string 6",
"reference_back_office": "sample string 7",
"modified_dateutc": "2026-08-21T18:59:15.2058761+00:00",
"db_currency_id": "39cd789e-c34f-4095-8639-9af3bfe7ad97",
"db_currency_code": "sample string 10"
},
"company_type_id": "2df39084-d9cd-49d8-b624-8dca6fbf4638",
"company_type_name": "sample string 32",
"company_type": {
"id": "cd2fec94-567e-4307-969e-d778338d0096",
"name": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "4c6a39bc-e2b5-475b-9373-0aa66ea40a4d",
"sales_organization_code": "sample string 5"
},
"db_language_id": "44cd36ae-0053-457c-b13f-2e6fc2a27d87",
"db_language_code": "sample string 34",
"code": "sample string 35",
"article_price_label_id": "661540de-2953-43fe-842e-58a9002e6b7a",
"article_price_label_code": "sample string 37",
"db_payment_method_id": "c0b48c96-d9ea-4aaf-8df9-e3c81bd8237b",
"db_payment_method_reference_back_office": "sample string 39",
"db_payment_methods": {
"id": "eee50d37-04b3-4c1e-a8fc-ceddbdbe1e41",
"name": "sample string 2",
"description": "sample string 3",
"reference_back_office": "sample string 4",
"activated": true,
"modified_dateutc": "2026-08-21T18:59:15.2058761+00:00"
},
"company_sector_id": "7773eb80-04f5-465a-b8ff-a6f688cebfb3",
"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": "da48bda5-bc4d-45a4-89ba-16b7a5331cea",
"service_manager_user_code": "sample string 52",
"finance_manager_user_id": "6bfec831-e026-4be7-a749-22a7b3a587eb",
"finance_manager_user_code": "sample string 54",
"account_manager_user_id": "d67ac0b7-e524-4be5-8ef0-506eb4df4b5e",
"account_manager_user_code": "sample string 56",
"company_status_id": "53f04ad8-e34d-447c-be86-b728c3407abd",
"invoice_email_to": "sample string 58",
"modified_dateutc": "2026-08-21T18:59:15.2058761+00:00",
"id2": 60
},
"db_language_id": "7ce981f9-9677-4149-b7ee-e1dbff8d3cd7",
"db_language_code": "sample string 7",
"db_title_id": "d596a2a7-a79e-4edd-8264-530bd285fc7f",
"archived": true,
"functions": "sample string 10",
"e_login": "sample string 11",
"e_password": "sample string 12",
"notes": "sample string 13",
"birthdate": "2026-08-21T18:59:15.2058761+00:00",
"create_date": "2026-08-21T18:59:15.2058761+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-08-21T18:59:15.2058761+00:00"
},
"modified_dateutc": "2026-08-21T18:59:15.2058761+00:00",
"id2": 22
}