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": "0638801a-0589-475d-8f0a-265e2d7e36ea",
"_parent_id": "0f77cd96-9d5e-47d3-9c41-9e5586946884",
"_parent_reference_back_office": "sample string 3",
"project_status_id": "925597a5-980b-401f-a4c0-52b3f1935fbe",
"company_id": "91d0bdcb-3b01-4e62-958c-cd8b00ff6bee",
"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": "be92e143-a76b-4f5b-9066-65db31672a54",
"db_country_code": "sample string 17",
"street2": "sample string 18",
"latitude_decimal": 1.0,
"longitude_decimal": 1.0,
"contact_id": "052991d4-07a8-4dec-8118-268dcaa509e0",
"contact_reference_back_office": "sample string 20",
"contact": {
"id": "2e44f1b3-d005-4e26-b2ea-59c9c827aa51",
"firstname": "sample string 2",
"lastname": "sample string 3",
"company_id": "982c8269-d449-4145-9840-c748af2066ad",
"company_code": "sample string 5",
"company": {
"id": "9eb8d652-a9f7-41cf-a4c3-2298c12319c0",
"is_client": true,
"is_supplier": true,
"archived": true,
"name": "sample string 5",
"notes": "sample string 6",
"create_date": "2025-10-27T01:28:06.1696114+00:00",
"sales_territory_id": "ec75fa24-7ab4-4a06-a5e9-dd1860309f80",
"sales_territory_code": "sample string 9",
"sales_territory": {
"id": "ce2d341a-c225-4c95-96e8-8bd50df9fb7a",
"code": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "2a9fc336-946d-4c12-ba95-47f79b76f5f6",
"sales_organization_code": "sample string 5",
"sales_organization": {
"id": "48068bbd-f044-4e01-814c-18f010d7ec24",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "122485d5-2118-46ac-8386-660a493e309b",
"db_currency_id": "5763983d-a97a-4e4d-90a6-48f3b6d2e2e8",
"db_language_id": "c00170b7-8569-47ea-a35d-7787c3928ce0",
"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-27T01:28:06.1696114+00:00"
},
"modified_dateutc": "2025-10-27T01:28:06.1696114+00:00"
},
"marketing_segment_id": "1203a58b-7f59-4a9d-951d-a5e4ce065691",
"marketing_segment_code": "sample string 11",
"sales_organization_id": "d2df40bc-d618-4689-9f10-e1c8dacf5b9f",
"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": "a01eec0f-d021-48a5-a274-cd58362faef3",
"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": "4235d015-65fa-4c77-9c5f-44e7a30a3f6e",
"db_country_code": "sample string 28",
"feelist_id": "c3ba8d85-8e74-432d-9a4e-0054206cff66",
"feelist_reference_back_office": "sample string 30",
"feelist": {
"id": "4d156a7b-462d-48ce-8a07-41f53b1b68b6",
"name": "sample string 2",
"description": "sample string 3",
"is_default": true,
"default_price": 1.0,
"sales_organization_id": "ba21c49c-8708-4bd3-92d4-e06446c8106e",
"sales_organization_code": "sample string 6",
"reference_back_office": "sample string 7",
"modified_dateutc": "2025-10-27T01:28:06.1696114+00:00",
"db_currency_id": "cb06a09b-e0c2-476c-a5ff-b61109b6a42d",
"db_currency_code": "sample string 10"
},
"company_type_id": "0043b620-7b21-4cf4-a3c4-6c887c8b6323",
"company_type_name": "sample string 32",
"company_type": {
"id": "4f687005-aead-4195-8cad-e11b73041358",
"name": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "b510e398-cfbc-4dd4-a4d7-1b7b675c6a45",
"sales_organization_code": "sample string 5"
},
"db_language_id": "421f1682-3bc9-4c55-913b-3b1eb062d593",
"db_language_code": "sample string 34",
"code": "sample string 35",
"article_price_label_id": "6a6d5fb4-d7a7-40d4-acdd-6d000c41d44d",
"article_price_label_code": "sample string 37",
"db_payment_method_id": "71475405-3888-483d-900b-c4252f56c39f",
"db_payment_method_reference_back_office": "sample string 39",
"db_payment_methods": {
"id": "093e7c77-5a1d-4ba6-ad84-8114c7d0aa96",
"name": "sample string 2",
"description": "sample string 3",
"reference_back_office": "sample string 4",
"activated": true,
"modified_dateutc": "2025-10-27T01:28:06.1696114+00:00"
},
"company_sector_id": "8c1e097b-d373-4270-b784-d345f1310e31",
"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": "976a70b2-bbdc-461e-9606-7a228c49ad0a",
"service_manager_user_code": "sample string 52",
"finance_manager_user_id": "d012df48-32f7-4a0d-8118-8235c76cdbe2",
"finance_manager_user_code": "sample string 54",
"account_manager_user_id": "d6f91ed7-8554-45b1-8f7e-ab8f88aa926b",
"account_manager_user_code": "sample string 56",
"company_status_id": "46431694-7030-4e50-a081-d18a65b4c4fc",
"invoice_email_to": "sample string 58",
"modified_dateutc": "2025-10-27T01:28:06.1696114+00:00",
"id2": 60
},
"db_language_id": "b4ea733b-746b-40b4-bf7c-c2ade2ef8159",
"db_language_code": "sample string 7",
"db_title_id": "2ccec2c1-1d2f-4b2d-a099-318f8220003e",
"archived": true,
"functions": "sample string 10",
"e_login": "sample string 11",
"e_password": "sample string 12",
"notes": "sample string 13",
"birthdate": "2025-10-27T01:28:06.1696114+00:00",
"create_date": "2025-10-27T01:28:06.1696114+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-27T01:28:06.1696114+00:00"
},
"modified_dateutc": "2025-10-27T01:28:06.1696114+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": "3c41346f-bcd8-41bf-973c-c264acc71564",
"_parent_id": "2eaaa5de-7ea4-4fd3-9651-10dc3a1de8a7",
"_parent_reference_back_office": "sample string 3",
"project_status_id": "b70c5afe-a4d1-40e6-ac75-cf13c531eb30",
"company_id": "9467d6c8-4053-4a6b-9a6a-ffb738ced0f4",
"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": "1e735c6f-25bf-40e0-9a54-70be04304f05",
"db_country_code": "sample string 17",
"street2": "sample string 18",
"latitude_decimal": 1.0,
"longitude_decimal": 1.0,
"contact_id": "cac96005-ea9f-4703-8cd1-97e8c43526c2",
"contact_reference_back_office": "sample string 20",
"contact": {
"id": "11b6fdef-f7d8-4a33-8df2-eaae766746de",
"firstname": "sample string 2",
"lastname": "sample string 3",
"company_id": "4ce33b57-fe31-4be8-b539-bd5bf1bd2fc4",
"company_code": "sample string 5",
"company": {
"id": "30245893-524a-4783-9ff4-d88cd6eb9249",
"is_client": true,
"is_supplier": true,
"archived": true,
"name": "sample string 5",
"notes": "sample string 6",
"create_date": "2025-10-27T01:28:06.1696114+00:00",
"sales_territory_id": "bba7746c-a377-4587-b599-6428ca472f35",
"sales_territory_code": "sample string 9",
"sales_territory": {
"id": "54757a8a-5590-4eb3-8d7e-e6af9d230a28",
"code": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "a6889a33-a62b-457e-9d21-ec0e4ef10057",
"sales_organization_code": "sample string 5",
"sales_organization": {
"id": "e20cd83a-f4fa-4415-a440-9096da3cad26",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "a78d85fd-6ebb-4570-bc7f-7418ad161b89",
"db_currency_id": "604bf4a1-1a37-4752-9353-5de270ea7bb3",
"db_language_id": "17ca44d8-dc9c-44c3-9875-cdc5730fecb1",
"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-27T01:28:06.1696114+00:00"
},
"modified_dateutc": "2025-10-27T01:28:06.1696114+00:00"
},
"marketing_segment_id": "2c584118-edea-47d4-8950-c683ab085424",
"marketing_segment_code": "sample string 11",
"sales_organization_id": "15db05ff-394d-4105-bfd5-5de9b5c391ec",
"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": "e43076eb-dfc7-4980-9bd9-1371afc326e9",
"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": "d6b60194-a9be-4183-979a-506695377f81",
"db_country_code": "sample string 28",
"feelist_id": "c78bfbe5-ed45-4a3b-b274-a48cf99ecc6a",
"feelist_reference_back_office": "sample string 30",
"feelist": {
"id": "875c7900-ecc1-43ea-b299-3d82bd0bf9c5",
"name": "sample string 2",
"description": "sample string 3",
"is_default": true,
"default_price": 1.0,
"sales_organization_id": "262ab747-8d68-432a-9de3-37613b37ed9d",
"sales_organization_code": "sample string 6",
"reference_back_office": "sample string 7",
"modified_dateutc": "2025-10-27T01:28:06.1696114+00:00",
"db_currency_id": "187956e9-84e9-417f-a478-bebfb4cb33e5",
"db_currency_code": "sample string 10"
},
"company_type_id": "b9790f72-a5ed-4f41-a6bb-bd4a95a5b7aa",
"company_type_name": "sample string 32",
"company_type": {
"id": "94f49483-a7ad-4da7-91ed-85ceeb0de79d",
"name": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "cd72e835-f03b-4784-bc80-438509fe7a68",
"sales_organization_code": "sample string 5"
},
"db_language_id": "a1f43cca-ec37-4534-b09d-2b41d5437c1f",
"db_language_code": "sample string 34",
"code": "sample string 35",
"article_price_label_id": "45b1af71-b903-4338-94ae-f24305542851",
"article_price_label_code": "sample string 37",
"db_payment_method_id": "ed404358-a590-4344-80ae-2fc20675841b",
"db_payment_method_reference_back_office": "sample string 39",
"db_payment_methods": {
"id": "fbee0cfb-d161-4e07-ac74-5db513352fd1",
"name": "sample string 2",
"description": "sample string 3",
"reference_back_office": "sample string 4",
"activated": true,
"modified_dateutc": "2025-10-27T01:28:06.1696114+00:00"
},
"company_sector_id": "518b5c43-f716-4d03-a2d0-b320b18bb16c",
"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": "2221f735-82a6-4487-9b3a-bebf32a5f6f2",
"service_manager_user_code": "sample string 52",
"finance_manager_user_id": "d12d3adb-398d-45c4-bdbc-43c356386c61",
"finance_manager_user_code": "sample string 54",
"account_manager_user_id": "7ceabf5c-8958-4c22-835a-dcdfd99a5814",
"account_manager_user_code": "sample string 56",
"company_status_id": "16692554-4277-42a5-b576-89ffe96d4f18",
"invoice_email_to": "sample string 58",
"modified_dateutc": "2025-10-27T01:28:06.1696114+00:00",
"id2": 60
},
"db_language_id": "dd75ef90-a850-41ec-abb2-4cd63e3c7faa",
"db_language_code": "sample string 7",
"db_title_id": "f6534fae-234e-43ca-8617-0fa52e23911d",
"archived": true,
"functions": "sample string 10",
"e_login": "sample string 11",
"e_password": "sample string 12",
"notes": "sample string 13",
"birthdate": "2025-10-27T01:28:06.1696114+00:00",
"create_date": "2025-10-27T01:28:06.1696114+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-27T01:28:06.1696114+00:00"
},
"modified_dateutc": "2025-10-27T01:28:06.1696114+00:00",
"id2": 22
}