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": "2f1e1905-2dae-4128-b9d9-9bc91be9f9b8",
"_parent_id": "877baf17-5ada-40f2-bef6-278a560791d4",
"_parent_reference_back_office": "sample string 3",
"project_status_id": "4fb2b1f7-fe40-47a1-8077-73d7ffb2dbb6",
"company_id": "5806c1dd-dd0c-4aba-b8af-42706e77cc32",
"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": "06add1e3-5a6d-4d55-b27d-f77e6acff005",
"db_country_code": "sample string 17",
"street2": "sample string 18",
"latitude_decimal": 1.0,
"longitude_decimal": 1.0,
"contact_id": "bb4321b8-1c42-4e0f-a0db-581a05787051",
"contact_reference_back_office": "sample string 20",
"contact": {
"id": "196370bc-6545-4144-8cc2-e3f4864de871",
"firstname": "sample string 2",
"lastname": "sample string 3",
"company_id": "50ed61e1-975a-4b21-b09a-46cf3e9478ff",
"company_code": "sample string 5",
"company": {
"id": "bde9df80-3b3b-4f13-bac5-f81fb1e08559",
"is_client": true,
"is_supplier": true,
"archived": true,
"name": "sample string 5",
"notes": "sample string 6",
"create_date": "2025-04-03T01:50:04.7206148+00:00",
"sales_territory_id": "5573f1be-df11-4f68-a995-8de4461046ce",
"sales_territory_code": "sample string 9",
"sales_territory": {
"id": "4042f207-9980-4a3c-8393-35d0769323ad",
"code": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "c852efbc-f165-4fc4-9814-161240e63fed",
"sales_organization_code": "sample string 5",
"sales_organization": {
"id": "037e1fe6-0eb1-48e4-9770-954387d3f1b0",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "bd881211-af10-4595-98a6-09731525c782",
"db_currency_id": "2405dd56-049e-4b9e-8996-a42b3d3c3f0e",
"db_language_id": "8dfa97d6-94de-42f7-ada0-5a3436c958b2",
"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-04-03T01:50:04.7206148+00:00"
},
"modified_dateutc": "2025-04-03T01:50:04.7206148+00:00"
},
"marketing_segment_id": "9c965d9a-0196-4e4a-8bce-1b7c3fb47419",
"marketing_segment_code": "sample string 11",
"sales_organization_id": "675ddce1-d042-4b96-ad7c-088392dea9a7",
"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": "ec939f1d-b8b9-4b0c-9959-a79b921871fc",
"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": "2e7e9c16-1ef9-4eb4-a0ac-b19399c3008a",
"db_country_code": "sample string 28",
"feelist_id": "7c46049a-a355-4d2c-979b-b2a2746b27ea",
"feelist_reference_back_office": "sample string 30",
"feelist": {
"id": "9ab8b23e-85a0-407a-a8cc-03e565df4453",
"name": "sample string 2",
"description": "sample string 3",
"is_default": true,
"default_price": 1.0,
"sales_organization_id": "6a8690ad-6dd7-462f-b81a-97d6cf8477ad",
"sales_organization_code": "sample string 6",
"reference_back_office": "sample string 7",
"modified_dateutc": "2025-04-03T01:50:04.7206148+00:00",
"db_currency_id": "ac04539b-1576-4697-a947-065d2d30c75e",
"db_currency_code": "sample string 10"
},
"company_type_id": "9df01871-9e2e-453a-b761-109a3c80362a",
"company_type_name": "sample string 32",
"company_type": {
"id": "d2f2a713-8a19-413f-8415-8cd2e33ed967",
"name": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "24af235b-67b6-4117-b73c-a768dda1377e",
"sales_organization_code": "sample string 5"
},
"db_language_id": "9f6afab2-1bc2-4cbc-b070-009dc26d30ea",
"db_language_code": "sample string 34",
"code": "sample string 35",
"article_price_label_id": "ab9a4162-a747-4779-bb79-0179120686cd",
"article_price_label_code": "sample string 37",
"db_payment_method_id": "65e6ee49-28c3-4542-9a7f-a9ec0389f509",
"db_payment_method_reference_back_office": "sample string 39",
"db_payment_methods": {
"id": "a1125a45-4af1-4a7f-8438-68717384786c",
"name": "sample string 2",
"description": "sample string 3",
"reference_back_office": "sample string 4",
"activated": true,
"modified_dateutc": "2025-04-03T01:50:04.7206148+00:00"
},
"company_sector_id": "34690401-0da3-4f34-9352-b9de3e167713",
"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": "2b00fe49-3ae8-4a07-a097-af3e71132f2e",
"service_manager_user_code": "sample string 52",
"finance_manager_user_id": "9a5254c5-d898-4c0c-b0ec-960edb094ea2",
"finance_manager_user_code": "sample string 54",
"account_manager_user_id": "2e1a055e-ea33-4195-aaae-40bb8adee6e6",
"account_manager_user_code": "sample string 56",
"company_status_id": "62bdc663-ec79-49b9-a11d-3c83b8d84f76",
"invoice_email_to": "sample string 58",
"modified_dateutc": "2025-04-03T01:50:04.7206148+00:00",
"id2": 60
},
"db_language_id": "88381cda-84d1-4027-a0b9-9cee9b9c3b99",
"db_language_code": "sample string 7",
"db_title_id": "ee470a21-e33b-47da-a201-34524c8dbc46",
"archived": true,
"functions": "sample string 10",
"e_login": "sample string 11",
"e_password": "sample string 12",
"notes": "sample string 13",
"birthdate": "2025-04-03T01:50:04.7206148+00:00",
"create_date": "2025-04-03T01:50:04.7206148+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-04-03T01:50:04.7206148+00:00"
},
"modified_dateutc": "2025-04-03T01:50:04.7206148+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": "cc43f2f8-58ef-4ae3-bec0-e8e7e5d0e6ab",
"_parent_id": "8293dbf0-4d35-4fad-9874-8231a8ca22f0",
"_parent_reference_back_office": "sample string 3",
"project_status_id": "a4e87b94-78eb-4a3f-8811-f1c7af1c7e16",
"company_id": "8757f820-7aaf-4f8c-b7d4-221d91c15c47",
"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": "f5251046-8ae9-4224-9e30-170d1ad809de",
"db_country_code": "sample string 17",
"street2": "sample string 18",
"latitude_decimal": 1.0,
"longitude_decimal": 1.0,
"contact_id": "20ca1d7b-d973-4ea0-8af4-1fd4f26f0d42",
"contact_reference_back_office": "sample string 20",
"contact": {
"id": "59f8b3aa-4cfa-4819-903d-2286d1f8b484",
"firstname": "sample string 2",
"lastname": "sample string 3",
"company_id": "2f09d319-f17b-45c3-a02c-2afd4db952d4",
"company_code": "sample string 5",
"company": {
"id": "7347b487-f847-473d-9f85-0f475db399a9",
"is_client": true,
"is_supplier": true,
"archived": true,
"name": "sample string 5",
"notes": "sample string 6",
"create_date": "2025-04-03T01:50:04.73624+00:00",
"sales_territory_id": "be0828d8-8340-4591-915b-327d15e99b93",
"sales_territory_code": "sample string 9",
"sales_territory": {
"id": "0c3e697d-c7e5-4df3-905f-52ce38ce02a2",
"code": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "3700033b-17d8-47bb-b501-04b92498789c",
"sales_organization_code": "sample string 5",
"sales_organization": {
"id": "02001088-b63f-4f79-9968-3a2e0f2977b0",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "be8844c7-6ab2-42c6-a57e-f370f982f1e7",
"db_currency_id": "0381a12e-d6eb-4cbf-b5b1-7e882f7552a9",
"db_language_id": "03dbfe5f-5a6d-4b99-af0d-100747ef913d",
"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-04-03T01:50:04.73624+00:00"
},
"modified_dateutc": "2025-04-03T01:50:04.73624+00:00"
},
"marketing_segment_id": "757dc873-d314-4cd8-9dbb-2f6666bfeddc",
"marketing_segment_code": "sample string 11",
"sales_organization_id": "7ff18ef0-ceb6-450d-8539-05ac6913ef6e",
"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": "e58282d8-54da-458d-8c5a-070a4eefb045",
"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": "a32677ef-785c-4cb0-9c78-539c68590b38",
"db_country_code": "sample string 28",
"feelist_id": "7bf7e184-73a0-4c08-be80-4cdef48fb734",
"feelist_reference_back_office": "sample string 30",
"feelist": {
"id": "f765b21e-52e5-44b4-9547-244cdbbaeb29",
"name": "sample string 2",
"description": "sample string 3",
"is_default": true,
"default_price": 1.0,
"sales_organization_id": "a9991747-5d5d-4e0a-86d5-599731e333ba",
"sales_organization_code": "sample string 6",
"reference_back_office": "sample string 7",
"modified_dateutc": "2025-04-03T01:50:04.73624+00:00",
"db_currency_id": "3cf26c1a-e6a5-405b-a3cd-be3b867f1df3",
"db_currency_code": "sample string 10"
},
"company_type_id": "6c323167-7104-42ce-af45-b56ed8012661",
"company_type_name": "sample string 32",
"company_type": {
"id": "8cca33fb-eb8e-4367-8e36-f0f701f5e485",
"name": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "3e52a490-591b-4fcc-bdce-5220919621b1",
"sales_organization_code": "sample string 5"
},
"db_language_id": "b6247970-2202-4c19-b8ea-dc86a70aa55e",
"db_language_code": "sample string 34",
"code": "sample string 35",
"article_price_label_id": "3dac3d79-e5dc-4a81-beac-ffcf084e892c",
"article_price_label_code": "sample string 37",
"db_payment_method_id": "0592f672-1601-499f-94ed-eef8497a0ac1",
"db_payment_method_reference_back_office": "sample string 39",
"db_payment_methods": {
"id": "f61fab87-dd01-49fa-8c3d-9b485e95aed0",
"name": "sample string 2",
"description": "sample string 3",
"reference_back_office": "sample string 4",
"activated": true,
"modified_dateutc": "2025-04-03T01:50:04.73624+00:00"
},
"company_sector_id": "12616cfd-94ba-4271-8d8c-df80515359cc",
"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": "c3ba876a-8cba-468b-b1d1-77383aba0c41",
"service_manager_user_code": "sample string 52",
"finance_manager_user_id": "83f344b8-9eba-49a4-abb1-abdf6ec0845e",
"finance_manager_user_code": "sample string 54",
"account_manager_user_id": "5c0ec5af-7565-45c0-8d47-e4c3b86c82ff",
"account_manager_user_code": "sample string 56",
"company_status_id": "86b537a6-c678-4de6-9f75-bcfe9515823d",
"invoice_email_to": "sample string 58",
"modified_dateutc": "2025-04-03T01:50:04.73624+00:00",
"id2": 60
},
"db_language_id": "6c0d5a99-21f8-4308-b990-b8bdc9ee5ee3",
"db_language_code": "sample string 7",
"db_title_id": "95987c12-a8c3-4c0b-b77e-740d1d2de467",
"archived": true,
"functions": "sample string 10",
"e_login": "sample string 11",
"e_password": "sample string 12",
"notes": "sample string 13",
"birthdate": "2025-04-03T01:50:04.73624+00:00",
"create_date": "2025-04-03T01:50:04.73624+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-04-03T01:50:04.73624+00:00"
},
"modified_dateutc": "2025-04-03T01:50:04.73624+00:00",
"id2": 22
}