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": "bc635b53-52ea-4ed0-b6c2-398ace4be751",
"_parent_id": "96e35a61-d3e8-47fc-9c8e-453578241ceb",
"_parent_reference_back_office": "sample string 3",
"project_status_id": "175e85b8-abf3-4194-884c-511a99793e48",
"company_id": "2ed92241-2d41-4459-8dcd-fb4e8aabae04",
"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": "d06dddc6-161e-4d33-bedf-3ab3a0980da8",
"db_country_code": "sample string 17",
"street2": "sample string 18",
"latitude_decimal": 1.0,
"longitude_decimal": 1.0,
"contact_id": "945f4100-809c-4284-bee4-c48e9179de2f",
"contact_reference_back_office": "sample string 20",
"contact": {
"id": "50990b02-4de5-4b66-9ec2-080bcd734ba0",
"firstname": "sample string 2",
"lastname": "sample string 3",
"company_id": "dcfee659-918d-4c3c-be64-d9eaa3903047",
"company_code": "sample string 5",
"company": {
"id": "d2dcb726-7df5-47c9-8cf3-7fa99d08a8f4",
"is_client": true,
"is_supplier": true,
"archived": true,
"name": "sample string 5",
"notes": "sample string 6",
"create_date": "2026-05-01T16:03:28.1445803+00:00",
"sales_territory_id": "b6f11e42-a6fc-40d4-adbd-d1934c461a81",
"sales_territory_code": "sample string 9",
"sales_territory": {
"id": "df9c2ca6-7c54-4918-a582-2fa81f2c210e",
"code": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "daca48ab-e6a3-43b0-b6e5-6621d8eb1a80",
"sales_organization_code": "sample string 5",
"sales_organization": {
"id": "b8fbd11f-54d7-4008-81d5-0ba3973a0bd3",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "b22bd80d-87ed-4d5a-8619-35c6b1193911",
"db_currency_id": "df3769d9-4100-4fcf-bd11-d48312c510d7",
"db_language_id": "ccc6cab2-2fea-4152-b291-488fd1fd37e0",
"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-05-01T16:03:28.8320858+00:00"
},
"modified_dateutc": "2026-05-01T16:03:28.8320858+00:00"
},
"marketing_segment_id": "c539a31e-0c83-4e60-9f3d-7d54c27269a6",
"marketing_segment_code": "sample string 11",
"sales_organization_id": "ffade05d-7323-4677-bdee-dddd08804d82",
"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": "1d034781-5938-47b1-9f17-53af27665847",
"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": "620878cb-332d-463e-be37-f622facc8249",
"db_country_code": "sample string 28",
"feelist_id": "90f81d48-e4fc-4e2f-b2aa-ed26bdea5ce8",
"feelist_reference_back_office": "sample string 30",
"feelist": {
"id": "2f3a6070-acf8-4dd1-b2fa-ca6620625720",
"name": "sample string 2",
"description": "sample string 3",
"is_default": true,
"default_price": 1.0,
"sales_organization_id": "6502c51a-523e-46bf-99cb-61c925ff918d",
"sales_organization_code": "sample string 6",
"reference_back_office": "sample string 7",
"modified_dateutc": "2026-05-01T16:03:28.8320858+00:00",
"db_currency_id": "47226d9a-4bdc-4e34-843e-acb99da892f0",
"db_currency_code": "sample string 10"
},
"company_type_id": "d8dbbcde-55d2-4f21-aea0-83eb7a636f34",
"company_type_name": "sample string 32",
"company_type": {
"id": "34fc1060-2f28-4896-b2be-879b93c3dba1",
"name": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "3069f719-d56c-478a-927a-a7f8372b2569",
"sales_organization_code": "sample string 5"
},
"db_language_id": "1f5e7a06-3fba-4fd5-bfa2-89f8df5fb423",
"db_language_code": "sample string 34",
"code": "sample string 35",
"article_price_label_id": "58f9d393-f7ff-479c-96d2-e758614bd309",
"article_price_label_code": "sample string 37",
"db_payment_method_id": "a2fc7ff1-da37-4ae6-99cb-4ff9db65b5f2",
"db_payment_method_reference_back_office": "sample string 39",
"db_payment_methods": {
"id": "4f0e47e5-1a0d-448f-9f9b-12da6e8e9745",
"name": "sample string 2",
"description": "sample string 3",
"reference_back_office": "sample string 4",
"activated": true,
"modified_dateutc": "2026-05-01T16:03:28.8320858+00:00"
},
"company_sector_id": "16c66873-8e05-4a0e-8f50-72039ceb9352",
"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": "656ba472-bbc2-4c9e-922f-416a303f29a8",
"service_manager_user_code": "sample string 52",
"finance_manager_user_id": "540d1b0f-d1f1-4e5d-8584-41cdfa123466",
"finance_manager_user_code": "sample string 54",
"account_manager_user_id": "51724651-f65e-4024-ba97-ec1ba7a20fee",
"account_manager_user_code": "sample string 56",
"company_status_id": "98392af0-c062-4d2f-a3b9-3cf052e748d3",
"invoice_email_to": "sample string 58",
"modified_dateutc": "2026-05-01T16:03:28.8320858+00:00",
"id2": 60
},
"db_language_id": "30f22c43-1a3b-4487-82f1-e1ebd3f2412b",
"db_language_code": "sample string 7",
"db_title_id": "9c973859-121d-4432-b220-f6a28d3d9e21",
"archived": true,
"functions": "sample string 10",
"e_login": "sample string 11",
"e_password": "sample string 12",
"notes": "sample string 13",
"birthdate": "2026-05-01T16:03:28.8320858+00:00",
"create_date": "2026-05-01T16:03:28.8320858+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-05-01T16:03:28.8320858+00:00"
},
"modified_dateutc": "2026-05-01T16:03:28.8320858+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": "e00675e1-fada-45d2-add6-c8d3427ea5d6",
"_parent_id": "bc720925-b462-4f68-8c2a-aec68a4b5680",
"_parent_reference_back_office": "sample string 3",
"project_status_id": "df960418-b613-4e83-9ff4-ad0f7c3795e4",
"company_id": "857f7705-93a9-497d-9127-9ba650b66117",
"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": "c1d00b20-37fd-4080-b495-43c7eaf1a13b",
"db_country_code": "sample string 17",
"street2": "sample string 18",
"latitude_decimal": 1.0,
"longitude_decimal": 1.0,
"contact_id": "336ee548-ffc9-484e-b7d1-6db604176ad6",
"contact_reference_back_office": "sample string 20",
"contact": {
"id": "7639a98f-243b-4d1d-9236-5f92a6c9c627",
"firstname": "sample string 2",
"lastname": "sample string 3",
"company_id": "669a183a-2662-42f6-a466-c2a20f729ec9",
"company_code": "sample string 5",
"company": {
"id": "ed5a0979-acfa-4968-bee1-9a25140dddd1",
"is_client": true,
"is_supplier": true,
"archived": true,
"name": "sample string 5",
"notes": "sample string 6",
"create_date": "2026-05-01T16:03:28.8398405+00:00",
"sales_territory_id": "86d0062e-b1a4-40c5-b762-301146c57ac0",
"sales_territory_code": "sample string 9",
"sales_territory": {
"id": "aeb42e1d-c240-47b5-b1ec-3e0b4494e05c",
"code": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "cb8aa906-01be-4064-8c17-da5e79c75c4e",
"sales_organization_code": "sample string 5",
"sales_organization": {
"id": "0b2b509c-059d-4998-83ae-bdb1293354e2",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "8630411d-48d0-4e4b-9808-4cbf9b70e262",
"db_currency_id": "ef6fd441-7d13-4b82-97b5-65c6a5e786d4",
"db_language_id": "dd91b5dd-9b85-4505-83af-6094d8615f5e",
"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-05-01T16:03:28.8398405+00:00"
},
"modified_dateutc": "2026-05-01T16:03:28.8398405+00:00"
},
"marketing_segment_id": "8f031bcd-3d8d-45a6-bf42-22468eed9b12",
"marketing_segment_code": "sample string 11",
"sales_organization_id": "2081b1a0-dff1-44be-a209-fdbe35345b42",
"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": "9734ceac-fd24-437b-9828-cad15b441a5a",
"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": "cee25281-d3f4-4620-91f2-c9ab52a9d340",
"db_country_code": "sample string 28",
"feelist_id": "867b221d-9c5a-4afa-9c17-2f2eacd14996",
"feelist_reference_back_office": "sample string 30",
"feelist": {
"id": "3f3a31bf-e7af-4b34-ac7e-df6edc0aaffa",
"name": "sample string 2",
"description": "sample string 3",
"is_default": true,
"default_price": 1.0,
"sales_organization_id": "ae05edd6-44c3-44ad-ab52-394fd23bcfff",
"sales_organization_code": "sample string 6",
"reference_back_office": "sample string 7",
"modified_dateutc": "2026-05-01T16:03:28.8398405+00:00",
"db_currency_id": "d3362ce0-6898-404d-bbbe-441fd3f288ab",
"db_currency_code": "sample string 10"
},
"company_type_id": "c220fe66-f2d5-4810-a660-bb41244b29c3",
"company_type_name": "sample string 32",
"company_type": {
"id": "19cbde39-7fff-4b70-a1de-2a700ceeac46",
"name": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "6e4ee842-b747-4494-8264-16e614ccc77a",
"sales_organization_code": "sample string 5"
},
"db_language_id": "0d937fff-a014-43b0-8b0b-314ec81b812c",
"db_language_code": "sample string 34",
"code": "sample string 35",
"article_price_label_id": "e71fc316-7067-4963-bf0b-09910c7e9306",
"article_price_label_code": "sample string 37",
"db_payment_method_id": "1de7946d-e558-41d8-93f8-05f1fceb41a4",
"db_payment_method_reference_back_office": "sample string 39",
"db_payment_methods": {
"id": "50972b3f-bc59-44b5-a382-4a18b505bc63",
"name": "sample string 2",
"description": "sample string 3",
"reference_back_office": "sample string 4",
"activated": true,
"modified_dateutc": "2026-05-01T16:03:28.8398405+00:00"
},
"company_sector_id": "25688ea3-65a2-40e0-a45c-53cf452a3931",
"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": "ccd8be3b-ec63-424f-88f6-feac9b4fce84",
"service_manager_user_code": "sample string 52",
"finance_manager_user_id": "e61ce49e-22be-41e5-a389-1565b08d6d63",
"finance_manager_user_code": "sample string 54",
"account_manager_user_id": "ff294172-74b3-414f-a961-9468b6d41e8b",
"account_manager_user_code": "sample string 56",
"company_status_id": "c560e7ed-049b-435e-bb35-3778b6eabd42",
"invoice_email_to": "sample string 58",
"modified_dateutc": "2026-05-01T16:03:28.8398405+00:00",
"id2": 60
},
"db_language_id": "4b089eae-7405-4d7d-974a-10a9e6d00710",
"db_language_code": "sample string 7",
"db_title_id": "072d9cac-d7b7-497b-9286-41fa0346538e",
"archived": true,
"functions": "sample string 10",
"e_login": "sample string 11",
"e_password": "sample string 12",
"notes": "sample string 13",
"birthdate": "2026-05-01T16:03:28.8398405+00:00",
"create_date": "2026-05-01T16:03:28.8398405+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-05-01T16:03:28.8398405+00:00"
},
"modified_dateutc": "2026-05-01T16:03:28.8398405+00:00",
"id2": 22
}