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": "6fab96ec-b442-4dd6-9b3a-6dce84fcc5d7",
"_parent_id": "21e06647-08d1-4e41-8531-560684d67cec",
"_parent_reference_back_office": "sample string 3",
"project_status_id": "b8b11e59-bdc1-4ce7-8abb-b6c0ba2da779",
"company_id": "cf4f914c-47b3-4b54-bc1f-ae7a467e6cd4",
"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": "38e60543-fd66-44c8-966a-09aa9cb478d2",
"db_country_code": "sample string 17",
"street2": "sample string 18",
"latitude_decimal": 1.0,
"longitude_decimal": 1.0,
"contact_id": "93d77675-087c-49fc-8c66-0ec897c4daf4",
"contact_reference_back_office": "sample string 20",
"contact": {
"id": "e8958ceb-75da-4447-ac0d-401cc399887a",
"firstname": "sample string 2",
"lastname": "sample string 3",
"company_id": "7b518d4e-0297-4e08-b8e2-ee045def10ae",
"company_code": "sample string 5",
"company": {
"id": "86745ceb-1f79-4bdd-a1d1-afdc9ac15eef",
"is_client": true,
"is_supplier": true,
"archived": true,
"name": "sample string 5",
"notes": "sample string 6",
"create_date": "2025-10-01T02:41:28.9917193+00:00",
"sales_territory_id": "adf18ad9-28a6-4116-8b1b-7a1592917632",
"sales_territory_code": "sample string 9",
"sales_territory": {
"id": "d5457c09-4ab6-49f2-a35a-f8209672c4ca",
"code": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "56f84e1e-7240-45c2-8487-2c64557bf940",
"sales_organization_code": "sample string 5",
"sales_organization": {
"id": "be7b33c9-6112-43a4-a77b-2cafd4c6bbc3",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "07143a7e-17cb-469c-a2f6-89f46ed174a9",
"db_currency_id": "2b970c2b-1ef8-4aa9-b21e-b63a4fd43843",
"db_language_id": "367fa65a-95f0-4e89-b4cc-f807b36df383",
"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-01T02:41:28.9917193+00:00"
},
"modified_dateutc": "2025-10-01T02:41:28.9917193+00:00"
},
"marketing_segment_id": "82733053-f713-41f3-a2d6-5bb46bb154a3",
"marketing_segment_code": "sample string 11",
"sales_organization_id": "dc24e028-467a-4476-a608-5fcca958ff1b",
"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": "b6285fd8-d04e-4fee-b720-018903ce76ee",
"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": "7b059cde-eb21-4289-8349-9b460305f32c",
"db_country_code": "sample string 28",
"feelist_id": "a329c52a-c917-400d-8b8a-76e6a9e4eb28",
"feelist_reference_back_office": "sample string 30",
"feelist": {
"id": "bc51c5d8-6ee1-4a7e-94bb-aecd6866f1bb",
"name": "sample string 2",
"description": "sample string 3",
"is_default": true,
"default_price": 1.0,
"sales_organization_id": "5ab68207-2c05-405d-83df-d464a330aafa",
"sales_organization_code": "sample string 6",
"reference_back_office": "sample string 7",
"modified_dateutc": "2025-10-01T02:41:28.9917193+00:00",
"db_currency_id": "b13e557b-1037-4505-8177-314b81db5c0e",
"db_currency_code": "sample string 10"
},
"company_type_id": "0f0f7311-f8aa-424a-b88c-9d1f95d3e90e",
"company_type_name": "sample string 32",
"company_type": {
"id": "333a923a-82f9-45bf-8400-1a8f588d079e",
"name": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "184be942-ebbf-49d4-8b7b-6b8dde3417c4",
"sales_organization_code": "sample string 5"
},
"db_language_id": "02d0c0f5-f6b1-4ac4-933e-ffda2b89e679",
"db_language_code": "sample string 34",
"code": "sample string 35",
"article_price_label_id": "6271d055-5ecb-45cc-93a9-e082ee034d94",
"article_price_label_code": "sample string 37",
"db_payment_method_id": "b8f2908a-5cac-48ac-afb9-6eaf1cfea768",
"db_payment_method_reference_back_office": "sample string 39",
"db_payment_methods": {
"id": "d2f6d0b5-682f-47ea-935d-7f5c3cdb5675",
"name": "sample string 2",
"description": "sample string 3",
"reference_back_office": "sample string 4",
"activated": true,
"modified_dateutc": "2025-10-01T02:41:28.9917193+00:00"
},
"company_sector_id": "4ddad591-df43-4073-86a6-19ded6c1cf13",
"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": "26ab7eec-f417-4bbe-a326-4c9e5f10137e",
"service_manager_user_code": "sample string 52",
"finance_manager_user_id": "a6cdb6fa-48a7-4885-b5d9-51fbde711def",
"finance_manager_user_code": "sample string 54",
"account_manager_user_id": "73bf1a30-2b98-46bf-bb99-16bae1733520",
"account_manager_user_code": "sample string 56",
"company_status_id": "2b0c0aec-8030-499a-8ed6-fcc2e08da16c",
"invoice_email_to": "sample string 58",
"modified_dateutc": "2025-10-01T02:41:28.9917193+00:00",
"id2": 60
},
"db_language_id": "05286161-c304-4e77-baa2-5d5555220528",
"db_language_code": "sample string 7",
"db_title_id": "c7bf1c61-3b20-41b6-b7e3-c5ba7e2948a7",
"archived": true,
"functions": "sample string 10",
"e_login": "sample string 11",
"e_password": "sample string 12",
"notes": "sample string 13",
"birthdate": "2025-10-01T02:41:28.9917193+00:00",
"create_date": "2025-10-01T02:41:28.9917193+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-01T02:41:28.9917193+00:00"
},
"modified_dateutc": "2025-10-01T02:41:28.9917193+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": "15151cb9-8c89-4054-96fa-88c1ac758c3d",
"_parent_id": "16de0270-b5ad-47ab-a426-0963db883b2d",
"_parent_reference_back_office": "sample string 3",
"project_status_id": "a201b88d-a87a-4dc4-8463-fe35606fcd34",
"company_id": "5c872e45-8b0d-4162-8a2d-05210adf0338",
"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": "555fe426-b5e2-4b93-8f1a-438d76700e7d",
"db_country_code": "sample string 17",
"street2": "sample string 18",
"latitude_decimal": 1.0,
"longitude_decimal": 1.0,
"contact_id": "cca618c7-77ff-4bb7-88e2-744ecbbd9354",
"contact_reference_back_office": "sample string 20",
"contact": {
"id": "ffafe6ff-ce1b-4c90-a3eb-eefd02095918",
"firstname": "sample string 2",
"lastname": "sample string 3",
"company_id": "698c9ee8-cd13-4c53-af8b-cbd6b120fe35",
"company_code": "sample string 5",
"company": {
"id": "a54dc0b2-cc5a-4006-90ad-3f11308f4633",
"is_client": true,
"is_supplier": true,
"archived": true,
"name": "sample string 5",
"notes": "sample string 6",
"create_date": "2025-10-01T02:41:29.0073431+00:00",
"sales_territory_id": "fb3160e5-a421-4004-991f-1dd2b85ae59f",
"sales_territory_code": "sample string 9",
"sales_territory": {
"id": "be00a1dc-7813-4ebc-a1d9-a00d9f27ba0d",
"code": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "ae02c2d8-1a16-4210-88cf-c63527b08bcd",
"sales_organization_code": "sample string 5",
"sales_organization": {
"id": "2ec5f825-2146-4855-ab87-2c7a90f01850",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "c21bf570-6142-4e87-a308-a53899c95c89",
"db_currency_id": "fecf403b-700d-4257-b517-05894b56c528",
"db_language_id": "a72a735a-c8d0-4a85-b21a-aca7f292cec5",
"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-01T02:41:29.0073431+00:00"
},
"modified_dateutc": "2025-10-01T02:41:29.0073431+00:00"
},
"marketing_segment_id": "2fe4208b-eb91-4d00-b0f8-4cd2d733b1a6",
"marketing_segment_code": "sample string 11",
"sales_organization_id": "ba387211-ed8e-491d-bac1-8893c8bc01e8",
"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": "58cfb973-eeb2-4439-a40a-1d18be472b53",
"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": "74cef208-98ac-4786-8fc4-2d7d3a2584f6",
"db_country_code": "sample string 28",
"feelist_id": "5fbe5243-e79e-44dd-b15f-4d6882624775",
"feelist_reference_back_office": "sample string 30",
"feelist": {
"id": "3d49afac-4fff-4d4a-b68b-73c223b47451",
"name": "sample string 2",
"description": "sample string 3",
"is_default": true,
"default_price": 1.0,
"sales_organization_id": "8246c41f-217b-4dce-8243-d00260ad5293",
"sales_organization_code": "sample string 6",
"reference_back_office": "sample string 7",
"modified_dateutc": "2025-10-01T02:41:29.0073431+00:00",
"db_currency_id": "9d88221d-7153-4576-bcfc-0721867afea0",
"db_currency_code": "sample string 10"
},
"company_type_id": "09f76bc2-f7ad-4cbe-97f5-11073b2e76e6",
"company_type_name": "sample string 32",
"company_type": {
"id": "53b5b275-3ecb-40eb-8b59-41bc58e4171e",
"name": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "de16afda-7509-49a5-ae9b-9d97ee94d5d4",
"sales_organization_code": "sample string 5"
},
"db_language_id": "ad4504dc-4c7b-41ba-ac4f-34052b142479",
"db_language_code": "sample string 34",
"code": "sample string 35",
"article_price_label_id": "f6229452-3427-4068-a3ee-bbbcd4a27f38",
"article_price_label_code": "sample string 37",
"db_payment_method_id": "27d1ce45-ec48-40a1-a222-fea61cbd0b42",
"db_payment_method_reference_back_office": "sample string 39",
"db_payment_methods": {
"id": "06ca4898-fc4c-4fa4-bec3-7cdb6fb20ff7",
"name": "sample string 2",
"description": "sample string 3",
"reference_back_office": "sample string 4",
"activated": true,
"modified_dateutc": "2025-10-01T02:41:29.0073431+00:00"
},
"company_sector_id": "dbb69255-b602-4d21-b37c-c7ed1e2166a7",
"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": "476a2acf-803a-4fc9-bc96-6830e5da3fde",
"service_manager_user_code": "sample string 52",
"finance_manager_user_id": "6df3dddc-e6a4-447a-b354-d3794a1d6935",
"finance_manager_user_code": "sample string 54",
"account_manager_user_id": "8937eaab-8d73-4395-935f-2a76d6577e9e",
"account_manager_user_code": "sample string 56",
"company_status_id": "fb8bb50c-75fb-48fa-9e68-2e62015460db",
"invoice_email_to": "sample string 58",
"modified_dateutc": "2025-10-01T02:41:29.0073431+00:00",
"id2": 60
},
"db_language_id": "1f61a13c-ecd1-436b-a76b-6d9d749eb314",
"db_language_code": "sample string 7",
"db_title_id": "31603576-5dfc-42a6-a1d6-7813ef93d816",
"archived": true,
"functions": "sample string 10",
"e_login": "sample string 11",
"e_password": "sample string 12",
"notes": "sample string 13",
"birthdate": "2025-10-01T02:41:29.0073431+00:00",
"create_date": "2025-10-01T02:41:29.0073431+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-01T02:41:29.0073431+00:00"
},
"modified_dateutc": "2025-10-01T02:41:29.0073431+00:00",
"id2": 22
}