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": "740a2ab1-d78f-47cd-ae41-66e71ec15eb1",
"_parent_id": "a2b8d8f6-975e-411a-ae0b-339328018d8a",
"_parent_reference_back_office": "sample string 3",
"project_status_id": "ed373bfb-6c33-4973-a8d1-9d7ff9bfa214",
"company_id": "202f8c7e-7c15-4f18-b2cc-96eae19e98cb",
"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": "92697b45-b67d-437b-9e27-9b6984bca7f6",
"db_country_code": "sample string 17",
"street2": "sample string 18",
"latitude_decimal": 1.0,
"longitude_decimal": 1.0,
"contact_id": "0d20261f-a914-4955-bac5-807635bed030",
"contact_reference_back_office": "sample string 20",
"contact": {
"id": "1e4bbb32-460a-407b-8505-95711a769f99",
"firstname": "sample string 2",
"lastname": "sample string 3",
"company_id": "528af237-a8a7-44f0-ba3c-2b3d2e42bcc2",
"company_code": "sample string 5",
"company": {
"id": "f5838476-1934-4820-9784-11d33cb28d69",
"is_client": true,
"is_supplier": true,
"archived": true,
"name": "sample string 5",
"notes": "sample string 6",
"create_date": "2025-09-18T05:55:03.8410134+00:00",
"sales_territory_id": "3b224950-0180-4635-bf7b-58fbc5847c87",
"sales_territory_code": "sample string 9",
"sales_territory": {
"id": "a644f74a-dac4-474e-b376-3ce43e4ff0f5",
"code": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "ad793f25-904b-40fa-8fac-cf36106ca683",
"sales_organization_code": "sample string 5",
"sales_organization": {
"id": "af75a891-8c7c-48a5-8f60-f5782f57a598",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "f37b093e-efca-42c3-a01d-47670aec8a19",
"db_currency_id": "9fecc209-46e9-496c-bfc6-45a14e5aea2d",
"db_language_id": "da719538-5340-45e4-9cd1-48533d481b31",
"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-09-18T05:55:03.8410134+00:00"
},
"modified_dateutc": "2025-09-18T05:55:03.8410134+00:00"
},
"marketing_segment_id": "b1a651a1-2193-427f-9420-1355dd55e149",
"marketing_segment_code": "sample string 11",
"sales_organization_id": "c298c102-900f-4595-b67a-2175e7991668",
"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": "894a4c4d-5b59-401c-81ea-277cee779504",
"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": "d356e94a-8c25-453e-b0e1-e390a58e9d11",
"db_country_code": "sample string 28",
"feelist_id": "62ee7c06-ecf6-44f3-a44c-e7e038ecb17e",
"feelist_reference_back_office": "sample string 30",
"feelist": {
"id": "8ef40bbf-ba95-4e8f-9758-40758fcf1a55",
"name": "sample string 2",
"description": "sample string 3",
"is_default": true,
"default_price": 1.0,
"sales_organization_id": "47f2c0ea-5a4b-45ee-be73-7204cccbcd92",
"sales_organization_code": "sample string 6",
"reference_back_office": "sample string 7",
"modified_dateutc": "2025-09-18T05:55:03.8410134+00:00",
"db_currency_id": "a6459a1b-a1d8-4723-ba7a-673667add5c5",
"db_currency_code": "sample string 10"
},
"company_type_id": "216b5d4f-1e50-4f69-9abb-5bae51a20a82",
"company_type_name": "sample string 32",
"company_type": {
"id": "a7cc9f2a-44aa-43d4-8db5-1478104abd51",
"name": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "bca918e1-2c6b-4fe2-a071-dd68198b2627",
"sales_organization_code": "sample string 5"
},
"db_language_id": "7b8011a5-bbb2-489b-901e-84f47dc3a0dc",
"db_language_code": "sample string 34",
"code": "sample string 35",
"article_price_label_id": "9e815a59-5043-4989-bca7-024bdb95b0dd",
"article_price_label_code": "sample string 37",
"db_payment_method_id": "52c4fb91-c0e0-47c7-a19a-b3cace465de8",
"db_payment_method_reference_back_office": "sample string 39",
"db_payment_methods": {
"id": "bed19156-d163-4163-affa-239f28a963bd",
"name": "sample string 2",
"description": "sample string 3",
"reference_back_office": "sample string 4",
"activated": true,
"modified_dateutc": "2025-09-18T05:55:03.8410134+00:00"
},
"company_sector_id": "62e690d0-be43-4208-b9f0-1ca58e1ced05",
"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": "80bf2c06-58f1-4150-b616-45038d6d8e9e",
"service_manager_user_code": "sample string 52",
"finance_manager_user_id": "14bef3f1-6e74-45f3-80a5-db9c81ddbb1f",
"finance_manager_user_code": "sample string 54",
"account_manager_user_id": "8fe65d5c-7c5c-4f49-aa53-63f8c8a3c56c",
"account_manager_user_code": "sample string 56",
"company_status_id": "87f8fff8-1715-4662-aad4-cb7d4181a0c5",
"invoice_email_to": "sample string 58",
"modified_dateutc": "2025-09-18T05:55:03.8410134+00:00",
"id2": 60
},
"db_language_id": "40764fd0-a637-4c59-ae6d-703bd359b5cd",
"db_language_code": "sample string 7",
"db_title_id": "d4f9a819-0cf9-4da3-bbb8-28dd57a28195",
"archived": true,
"functions": "sample string 10",
"e_login": "sample string 11",
"e_password": "sample string 12",
"notes": "sample string 13",
"birthdate": "2025-09-18T05:55:03.8410134+00:00",
"create_date": "2025-09-18T05:55:03.8410134+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-09-18T05:55:03.8410134+00:00"
},
"modified_dateutc": "2025-09-18T05:55:03.8410134+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": "e39dba02-eebe-4de6-aba8-434532ec97bf",
"_parent_id": "b235a629-dc03-40f7-99d4-f91f85ab416a",
"_parent_reference_back_office": "sample string 3",
"project_status_id": "fa281698-1e0b-4328-887b-fba1ce35db51",
"company_id": "84a32742-9af0-401c-97b4-cf90a4f2aba6",
"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": "66fa0965-fa5e-4e99-9f1e-06b07c62ceb8",
"db_country_code": "sample string 17",
"street2": "sample string 18",
"latitude_decimal": 1.0,
"longitude_decimal": 1.0,
"contact_id": "50311aaa-aa0a-452f-be19-02c2e8562c92",
"contact_reference_back_office": "sample string 20",
"contact": {
"id": "f1599c12-c66d-43da-bd12-233b5d8a3b0c",
"firstname": "sample string 2",
"lastname": "sample string 3",
"company_id": "33319da6-33b8-4eeb-8cc4-5dd4bc47ef74",
"company_code": "sample string 5",
"company": {
"id": "8b3d6194-940c-414e-83aa-8b70dc5338aa",
"is_client": true,
"is_supplier": true,
"archived": true,
"name": "sample string 5",
"notes": "sample string 6",
"create_date": "2025-09-18T05:55:03.856636+00:00",
"sales_territory_id": "19cb92ca-33c5-407f-912c-432361041eb0",
"sales_territory_code": "sample string 9",
"sales_territory": {
"id": "1f230f95-3e96-4faa-9e80-60d540c3ddae",
"code": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "c2744bcc-d197-4b2a-bc76-a7d2e861b26d",
"sales_organization_code": "sample string 5",
"sales_organization": {
"id": "bba672f8-cbcc-43cd-aff3-f8d9c48646ca",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "e9d64961-672b-486d-b63c-98f67e6c2a96",
"db_currency_id": "83b8eaa6-bdf5-44c5-b259-260172be1b3d",
"db_language_id": "4c7af57a-bc3f-41a3-bac5-558657033ff3",
"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-09-18T05:55:03.856636+00:00"
},
"modified_dateutc": "2025-09-18T05:55:03.856636+00:00"
},
"marketing_segment_id": "3ec5051e-2ac8-458a-ab54-bee5b09c9a5e",
"marketing_segment_code": "sample string 11",
"sales_organization_id": "12372cbf-14c3-4d1f-a7b5-fad3d813b063",
"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": "5cfd70fb-5e96-4b9b-abbf-9c8ac4914a21",
"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": "2f5c018f-cc77-46fe-8570-625af98e6f3d",
"db_country_code": "sample string 28",
"feelist_id": "02519c1f-b82b-41d6-87d3-9de0ab068b11",
"feelist_reference_back_office": "sample string 30",
"feelist": {
"id": "ae5c5f4b-fd40-471e-af57-b5498e4107d5",
"name": "sample string 2",
"description": "sample string 3",
"is_default": true,
"default_price": 1.0,
"sales_organization_id": "ab397ed6-ee8e-410a-8011-4cae334e460e",
"sales_organization_code": "sample string 6",
"reference_back_office": "sample string 7",
"modified_dateutc": "2025-09-18T05:55:03.856636+00:00",
"db_currency_id": "ff4bda8c-7800-4cc2-823a-08f74483f9b6",
"db_currency_code": "sample string 10"
},
"company_type_id": "8f5572d5-8b19-42cc-8e41-df198f7bb795",
"company_type_name": "sample string 32",
"company_type": {
"id": "05af6308-cd83-4db6-be83-1d801a22d61b",
"name": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "b3d9703a-01ce-405f-9036-8c00fa052b39",
"sales_organization_code": "sample string 5"
},
"db_language_id": "041e57ed-ab00-4546-a1ff-a9bb26199ea7",
"db_language_code": "sample string 34",
"code": "sample string 35",
"article_price_label_id": "81f5e5db-0134-4244-b740-0a1d209b916b",
"article_price_label_code": "sample string 37",
"db_payment_method_id": "f5ebaf22-40f3-4160-8937-5b352bcb67bf",
"db_payment_method_reference_back_office": "sample string 39",
"db_payment_methods": {
"id": "6b310822-b0f4-46e5-aea1-2b60af81397c",
"name": "sample string 2",
"description": "sample string 3",
"reference_back_office": "sample string 4",
"activated": true,
"modified_dateutc": "2025-09-18T05:55:03.856636+00:00"
},
"company_sector_id": "07f14bb2-924b-470f-b6a3-03260dc22be0",
"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": "f5958575-0929-4d6c-8e7c-d36a76ab2938",
"service_manager_user_code": "sample string 52",
"finance_manager_user_id": "e2e6d077-1375-4676-aff9-7706fac40172",
"finance_manager_user_code": "sample string 54",
"account_manager_user_id": "941e749a-8d01-487d-a3df-2bd0b472f90e",
"account_manager_user_code": "sample string 56",
"company_status_id": "2beb86fb-cc5c-4f2b-8d92-442e48986c5e",
"invoice_email_to": "sample string 58",
"modified_dateutc": "2025-09-18T05:55:03.856636+00:00",
"id2": 60
},
"db_language_id": "33d091a0-7ab6-45f7-b211-a95dfe02f22a",
"db_language_code": "sample string 7",
"db_title_id": "128430e3-ae38-4e9d-be02-e2a823327fec",
"archived": true,
"functions": "sample string 10",
"e_login": "sample string 11",
"e_password": "sample string 12",
"notes": "sample string 13",
"birthdate": "2025-09-18T05:55:03.856636+00:00",
"create_date": "2025-09-18T05:55:03.856636+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-09-18T05:55:03.856636+00:00"
},
"modified_dateutc": "2025-09-18T05:55:03.856636+00:00",
"id2": 22
}