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": "3b5f64f4-1df1-49fb-8509-1154b9c207c3",
"_parent_id": "c5da7641-c708-482b-a83c-bebccc46f1a4",
"_parent_reference_back_office": "sample string 3",
"project_status_id": "b8928582-e4fa-40b5-b700-8d21ec74fd76",
"company_id": "845010d9-6112-4278-bf7e-9313d04b4eaa",
"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": "febb513a-6664-4190-8c20-208a02791cac",
"db_country_code": "sample string 17",
"street2": "sample string 18",
"latitude_decimal": 1.0,
"longitude_decimal": 1.0,
"contact_id": "019966de-0859-40ec-87f9-2f98f92fa95d",
"contact_reference_back_office": "sample string 20",
"contact": {
"id": "79490db8-e5f7-4575-8edd-2e1dc3d25ea2",
"firstname": "sample string 2",
"lastname": "sample string 3",
"company_id": "26ef3cd5-b485-4639-8f41-ed0a463aff84",
"company_code": "sample string 5",
"company": {
"id": "842d004f-b97b-474f-85ed-43fc4ae60045",
"is_client": true,
"is_supplier": true,
"archived": true,
"name": "sample string 5",
"notes": "sample string 6",
"create_date": "2025-11-13T07:31:38.3760308+00:00",
"sales_territory_id": "b5169a0f-39ae-479b-acaa-f266c401e58f",
"sales_territory_code": "sample string 9",
"sales_territory": {
"id": "030239e2-42f2-48fc-8af0-d36318df31a4",
"code": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "770f2422-c354-4028-91c3-2d059c5adeda",
"sales_organization_code": "sample string 5",
"sales_organization": {
"id": "d08d0ac7-c545-40df-9636-35cc219a223f",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "45a24edb-4887-4d48-8142-f962ad12cb11",
"db_currency_id": "1cfc012f-2e2e-4213-b251-21de42e93d0c",
"db_language_id": "9487c2de-9f01-49f8-af7f-5e448fea6fa5",
"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-11-13T07:31:38.3760308+00:00"
},
"modified_dateutc": "2025-11-13T07:31:38.3760308+00:00"
},
"marketing_segment_id": "35d6b407-14f0-4312-ada9-6541ebc5df18",
"marketing_segment_code": "sample string 11",
"sales_organization_id": "cba50626-03ec-4423-abef-cafcd474a679",
"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": "6c62465e-18fe-45f4-beee-eddb34b620ff",
"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": "8dbbbe9d-46d5-4cc2-bf61-88b7c689b9bc",
"db_country_code": "sample string 28",
"feelist_id": "afabe675-93b5-45ae-9ec9-7a525496ca48",
"feelist_reference_back_office": "sample string 30",
"feelist": {
"id": "608ad027-6912-49b5-aed8-7f4b910b4354",
"name": "sample string 2",
"description": "sample string 3",
"is_default": true,
"default_price": 1.0,
"sales_organization_id": "a023e18d-0409-4972-b460-8a420c54eec4",
"sales_organization_code": "sample string 6",
"reference_back_office": "sample string 7",
"modified_dateutc": "2025-11-13T07:31:38.3760308+00:00",
"db_currency_id": "e29e2138-124f-47d6-ae2b-11e1203fbe74",
"db_currency_code": "sample string 10"
},
"company_type_id": "66f18414-584b-4a8e-81f6-e491e0aed162",
"company_type_name": "sample string 32",
"company_type": {
"id": "66debe0f-1532-4351-8981-5ca5f9c4d9a8",
"name": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "ca8d672b-0de7-456d-a013-d0335b6bd691",
"sales_organization_code": "sample string 5"
},
"db_language_id": "1e4dd4f8-54d8-477e-87b2-75cbd6d563c5",
"db_language_code": "sample string 34",
"code": "sample string 35",
"article_price_label_id": "0a50adf2-f335-4f01-846b-f5f0d3beabf7",
"article_price_label_code": "sample string 37",
"db_payment_method_id": "bbf5b4a9-a5bf-4093-9936-14add3358828",
"db_payment_method_reference_back_office": "sample string 39",
"db_payment_methods": {
"id": "f2d844c1-2a0e-4d23-9494-cfadcd8e8d0e",
"name": "sample string 2",
"description": "sample string 3",
"reference_back_office": "sample string 4",
"activated": true,
"modified_dateutc": "2025-11-13T07:31:38.3760308+00:00"
},
"company_sector_id": "9167cbec-1355-4f07-a850-0f225bb813a7",
"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": "86ae9659-2705-4e0c-a385-0026348357a3",
"service_manager_user_code": "sample string 52",
"finance_manager_user_id": "37348219-6e0d-423b-84a4-fe1f095579d4",
"finance_manager_user_code": "sample string 54",
"account_manager_user_id": "481deb9a-cca8-4528-837a-a7782467551f",
"account_manager_user_code": "sample string 56",
"company_status_id": "f573e8de-03b4-4550-8b0f-b6d06f1c5c54",
"invoice_email_to": "sample string 58",
"modified_dateutc": "2025-11-13T07:31:38.3760308+00:00",
"id2": 60
},
"db_language_id": "f12b5aa8-269a-4e73-9c8b-cadcd6e654de",
"db_language_code": "sample string 7",
"db_title_id": "08b5b0a3-d2fe-4ed9-aa8f-97d544ee444e",
"archived": true,
"functions": "sample string 10",
"e_login": "sample string 11",
"e_password": "sample string 12",
"notes": "sample string 13",
"birthdate": "2025-11-13T07:31:38.3760308+00:00",
"create_date": "2025-11-13T07:31:38.3760308+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-11-13T07:31:38.3760308+00:00"
},
"modified_dateutc": "2025-11-13T07:31:38.3760308+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": "2c94a41f-f2aa-4f29-b818-1f239866f50f",
"_parent_id": "4115961d-c550-48fe-a1a3-e94a9748a95b",
"_parent_reference_back_office": "sample string 3",
"project_status_id": "06b3fbcb-bf1a-4127-96d0-1faaa00b5547",
"company_id": "41a87a0a-6cb4-4694-911f-69e5d2b2ea9b",
"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": "3d2803ad-e7d3-4238-86df-e428949f3060",
"db_country_code": "sample string 17",
"street2": "sample string 18",
"latitude_decimal": 1.0,
"longitude_decimal": 1.0,
"contact_id": "eabe54a0-0a80-4362-9332-f78bb6798713",
"contact_reference_back_office": "sample string 20",
"contact": {
"id": "27e1e093-d785-456c-a1d9-5cce18731534",
"firstname": "sample string 2",
"lastname": "sample string 3",
"company_id": "59bad38d-38e8-49a8-9621-c63098f28f6d",
"company_code": "sample string 5",
"company": {
"id": "cf30dc92-696b-4dde-8f51-99285e7b6542",
"is_client": true,
"is_supplier": true,
"archived": true,
"name": "sample string 5",
"notes": "sample string 6",
"create_date": "2025-11-13T07:31:38.3760308+00:00",
"sales_territory_id": "3d25428c-74bf-4955-a34d-0c9231b5193d",
"sales_territory_code": "sample string 9",
"sales_territory": {
"id": "9f36bdae-25ed-477c-8217-dd7904431f46",
"code": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "ae3aeb4c-2adf-4d39-9d93-2b147a8cc78d",
"sales_organization_code": "sample string 5",
"sales_organization": {
"id": "6a26e1fa-1a2d-496e-86ba-9a75b1fef50e",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "a1e60451-6a52-4bf4-a38b-3bb1106296aa",
"db_currency_id": "6a97a333-bd8c-4112-b42a-5529cc8b7716",
"db_language_id": "da88a6ca-edc3-488d-9c5f-78408d936c53",
"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-11-13T07:31:38.3760308+00:00"
},
"modified_dateutc": "2025-11-13T07:31:38.3760308+00:00"
},
"marketing_segment_id": "fa0badaa-5dbe-4e18-911b-380623b7800c",
"marketing_segment_code": "sample string 11",
"sales_organization_id": "b3ae829f-0fae-4a2d-9de9-de4b63bd2dc7",
"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": "d507d26c-a5fb-43a3-846c-268e0a9842d8",
"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": "2f293fd8-243a-460d-9fba-49c42e110a24",
"db_country_code": "sample string 28",
"feelist_id": "9f0e3909-3b7c-49a4-85da-05673955d205",
"feelist_reference_back_office": "sample string 30",
"feelist": {
"id": "c8a2cc51-44a7-4cd8-b3f3-9d2eb62bb11b",
"name": "sample string 2",
"description": "sample string 3",
"is_default": true,
"default_price": 1.0,
"sales_organization_id": "79a7d8ab-7cae-4b00-84b6-5ccc8cb088d2",
"sales_organization_code": "sample string 6",
"reference_back_office": "sample string 7",
"modified_dateutc": "2025-11-13T07:31:38.3760308+00:00",
"db_currency_id": "09ddb052-4550-4999-8ae4-e0c3b716bd36",
"db_currency_code": "sample string 10"
},
"company_type_id": "eb36ed05-fa18-4943-bd8f-0a79b7dcd2a9",
"company_type_name": "sample string 32",
"company_type": {
"id": "f30368e3-625f-45ea-b1a6-c8fe0383ad4e",
"name": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "b3299f44-50b0-4e74-9e2f-fbbe504892f3",
"sales_organization_code": "sample string 5"
},
"db_language_id": "e1907835-6a04-48d2-af12-26694da46b81",
"db_language_code": "sample string 34",
"code": "sample string 35",
"article_price_label_id": "a7b55364-5747-443b-858b-f9d941f14df3",
"article_price_label_code": "sample string 37",
"db_payment_method_id": "7512c312-b757-4d4e-98a3-2f1c3aaff06a",
"db_payment_method_reference_back_office": "sample string 39",
"db_payment_methods": {
"id": "658ede96-2b7b-4a84-9d10-6607ed051b2e",
"name": "sample string 2",
"description": "sample string 3",
"reference_back_office": "sample string 4",
"activated": true,
"modified_dateutc": "2025-11-13T07:31:38.3760308+00:00"
},
"company_sector_id": "5c957963-6719-402e-98cc-cc24d9686281",
"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": "a8717428-e937-4348-9855-ae2d49b47153",
"service_manager_user_code": "sample string 52",
"finance_manager_user_id": "e3a4cf0a-7194-4a78-82a1-8815a65cb3ac",
"finance_manager_user_code": "sample string 54",
"account_manager_user_id": "6626b9f7-7e3d-4c30-8422-78061ffb7f81",
"account_manager_user_code": "sample string 56",
"company_status_id": "df17ff8f-8ecd-46b6-8d30-a7885ba5cd17",
"invoice_email_to": "sample string 58",
"modified_dateutc": "2025-11-13T07:31:38.3760308+00:00",
"id2": 60
},
"db_language_id": "f1f061a1-89cb-42a7-adcb-4d899ca2c986",
"db_language_code": "sample string 7",
"db_title_id": "bdbbd3b2-2281-41af-b044-fd3445715379",
"archived": true,
"functions": "sample string 10",
"e_login": "sample string 11",
"e_password": "sample string 12",
"notes": "sample string 13",
"birthdate": "2025-11-13T07:31:38.3760308+00:00",
"create_date": "2025-11-13T07:31:38.3760308+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-11-13T07:31:38.3760308+00:00"
},
"modified_dateutc": "2025-11-13T07:31:38.3760308+00:00",
"id2": 22
}