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": "6940861d-eb08-4194-a927-c57df7b0c773",
"_parent_id": "d8be7fa2-9b59-4847-95f0-d1badcc91111",
"_parent_reference_back_office": "sample string 3",
"project_status_id": "f5bef69d-caa2-47e9-9d8d-24ac4fe9c9b8",
"company_id": "2bf57660-679d-4b47-8c22-f6afb2738617",
"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": "b795239e-5dca-4ea6-8dd8-d076a078bac8",
"db_country_code": "sample string 17",
"street2": "sample string 18",
"latitude_decimal": 1.0,
"longitude_decimal": 1.0,
"contact_id": "a81918c7-b014-41a4-b5ea-4789c2a2c020",
"contact_reference_back_office": "sample string 20",
"contact": {
"id": "c6191386-06db-4cf7-80c5-d98f0ed6e442",
"firstname": "sample string 2",
"lastname": "sample string 3",
"company_id": "b5f77dc9-9429-4f27-ad4c-5bdc1f353ea3",
"company_code": "sample string 5",
"company": {
"id": "e6de7a3d-14ca-47e1-a8cb-3e4c1e1bd6eb",
"is_client": true,
"is_supplier": true,
"archived": true,
"name": "sample string 5",
"notes": "sample string 6",
"create_date": "2025-06-03T08:31:37.8397823+00:00",
"sales_territory_id": "9cbe7f0e-d0f2-4b82-8b92-df491d3910e6",
"sales_territory_code": "sample string 9",
"sales_territory": {
"id": "3d6aaaf2-5482-4e4f-8d6b-d78a58b0511b",
"code": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "5011a0c3-f574-4683-99e1-090b94364b96",
"sales_organization_code": "sample string 5",
"sales_organization": {
"id": "eab5b1a9-9ec0-449e-9e8b-5d9a14a9bf8e",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "14ad805b-3be1-4e26-87d2-2f9799c624f4",
"db_currency_id": "d1559682-fc09-4789-a054-fbf02ed5f28f",
"db_language_id": "797ae61c-e9a9-481d-aaef-271aa592e1f9",
"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-06-03T08:31:37.8397823+00:00"
},
"modified_dateutc": "2025-06-03T08:31:37.8397823+00:00"
},
"marketing_segment_id": "9996b840-bf79-42dd-9797-720a73d541b1",
"marketing_segment_code": "sample string 11",
"sales_organization_id": "14863ffb-b923-4fe5-a6d0-76eef01f3cdb",
"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": "6d65b3da-a280-47ae-be48-7afa4a33ccdd",
"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": "8f12c359-d058-48c5-a7d3-108b17b89f47",
"db_country_code": "sample string 28",
"feelist_id": "6b0c63f0-20c3-4df4-b9c1-50df6aed1a11",
"feelist_reference_back_office": "sample string 30",
"feelist": {
"id": "a561b49b-3053-4917-937e-c91a0a4f94ac",
"name": "sample string 2",
"description": "sample string 3",
"is_default": true,
"default_price": 1.0,
"sales_organization_id": "7bd208e5-d1fb-4452-9d27-78d196ecba0e",
"sales_organization_code": "sample string 6",
"reference_back_office": "sample string 7",
"modified_dateutc": "2025-06-03T08:31:37.8397823+00:00",
"db_currency_id": "41b30c65-b1ef-494f-b21e-b9ddba2aa135",
"db_currency_code": "sample string 10"
},
"company_type_id": "74d94550-9ce7-4c0b-b913-31e8d96aa1f3",
"company_type_name": "sample string 32",
"company_type": {
"id": "b12518cd-88cd-4351-b8c4-8eb0d8d143d8",
"name": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "673781bc-968e-4cd3-b839-8f968c83ba09",
"sales_organization_code": "sample string 5"
},
"db_language_id": "baeeb883-d75c-47ef-ba80-5b76b5595c0f",
"db_language_code": "sample string 34",
"code": "sample string 35",
"article_price_label_id": "d1c4d6c7-0c98-4d0d-bcb5-204f68c1972a",
"article_price_label_code": "sample string 37",
"db_payment_method_id": "dbb6158c-fa8c-4861-bbb2-38f116f2d2a3",
"db_payment_method_reference_back_office": "sample string 39",
"db_payment_methods": {
"id": "33a99f7d-4a0b-4175-b337-7ba5a9337dcb",
"name": "sample string 2",
"description": "sample string 3",
"reference_back_office": "sample string 4",
"activated": true,
"modified_dateutc": "2025-06-03T08:31:37.8397823+00:00"
},
"company_sector_id": "90c39222-af6d-46bd-bd7a-ae094062f151",
"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": "64de6748-33cb-426c-b572-f11f8d4157aa",
"service_manager_user_code": "sample string 52",
"finance_manager_user_id": "db9ac898-1b30-4367-a018-ad866ec151c0",
"finance_manager_user_code": "sample string 54",
"account_manager_user_id": "6328b187-4987-4e75-8828-3bc2d39c2ac6",
"account_manager_user_code": "sample string 56",
"company_status_id": "e92fad41-e875-4d2d-9b00-fc9890c2c774",
"invoice_email_to": "sample string 58",
"modified_dateutc": "2025-06-03T08:31:37.8397823+00:00",
"id2": 60
},
"db_language_id": "e1576442-9ec6-49d0-9575-c08f6590b586",
"db_language_code": "sample string 7",
"db_title_id": "ed6c0968-7900-417c-acaf-ad7f297a21db",
"archived": true,
"functions": "sample string 10",
"e_login": "sample string 11",
"e_password": "sample string 12",
"notes": "sample string 13",
"birthdate": "2025-06-03T08:31:37.8397823+00:00",
"create_date": "2025-06-03T08:31:37.8397823+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-06-03T08:31:37.8397823+00:00"
},
"modified_dateutc": "2025-06-03T08:31:37.8397823+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": "da4a380e-4c2c-4072-85ee-5e231fd563d1",
"_parent_id": "e998a645-c79f-463d-a791-881b2d9d29c3",
"_parent_reference_back_office": "sample string 3",
"project_status_id": "76346e19-bde5-431b-a227-6abc4211c4f9",
"company_id": "b4083ea7-bb06-426f-824b-f9d8a6d8b372",
"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": "f44a0dbe-dfcd-4a82-bf1f-a041582c4a11",
"db_country_code": "sample string 17",
"street2": "sample string 18",
"latitude_decimal": 1.0,
"longitude_decimal": 1.0,
"contact_id": "f32cabbc-7999-4afa-af51-d8f02e43c33f",
"contact_reference_back_office": "sample string 20",
"contact": {
"id": "3110f579-c367-4623-96aa-34f504dac200",
"firstname": "sample string 2",
"lastname": "sample string 3",
"company_id": "474bf201-bd3f-4e28-b7b2-e802dee953f8",
"company_code": "sample string 5",
"company": {
"id": "d2d57a57-bd28-4e6a-9287-e456e9533048",
"is_client": true,
"is_supplier": true,
"archived": true,
"name": "sample string 5",
"notes": "sample string 6",
"create_date": "2025-06-03T08:31:37.8397823+00:00",
"sales_territory_id": "891d0b6c-2562-48f7-9111-87b1c70bf61e",
"sales_territory_code": "sample string 9",
"sales_territory": {
"id": "d5bf9380-61a6-442b-b210-f520e3afef76",
"code": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "0b89ae76-b909-418b-8160-66e3f2f892ee",
"sales_organization_code": "sample string 5",
"sales_organization": {
"id": "440ba4cb-5b25-4830-9bd1-16f0e68993cf",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "923fe3c3-fbe7-4272-87d8-d681ebe4b7ac",
"db_currency_id": "e337d0e6-8889-499f-affa-4f9919be00bf",
"db_language_id": "227c8c5c-032d-4785-8a4d-bbbb0f914907",
"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-06-03T08:31:37.8397823+00:00"
},
"modified_dateutc": "2025-06-03T08:31:37.8397823+00:00"
},
"marketing_segment_id": "9f68afdf-ca6c-4471-b3e3-3aff37a0f131",
"marketing_segment_code": "sample string 11",
"sales_organization_id": "c1183171-26f3-45ac-a835-46c11a447f8a",
"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": "0a2b3938-d40e-4d27-947e-aa4678f8d7d2",
"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": "63e07c77-fa9a-4051-a12f-9ceb4dd4386c",
"db_country_code": "sample string 28",
"feelist_id": "5ec25a6d-49ab-4a1d-9387-dfc2a8d88dc2",
"feelist_reference_back_office": "sample string 30",
"feelist": {
"id": "0b7e05d9-8b49-4c3f-aae8-79bac10c91f9",
"name": "sample string 2",
"description": "sample string 3",
"is_default": true,
"default_price": 1.0,
"sales_organization_id": "2659be66-9c1a-4b6f-becd-8243781beb76",
"sales_organization_code": "sample string 6",
"reference_back_office": "sample string 7",
"modified_dateutc": "2025-06-03T08:31:37.8397823+00:00",
"db_currency_id": "de19cd74-190a-47f4-aaa0-6c6986e035ce",
"db_currency_code": "sample string 10"
},
"company_type_id": "f6ae2ae4-dbe5-47f8-aa49-ce0ab03d25ac",
"company_type_name": "sample string 32",
"company_type": {
"id": "f098bb14-96c5-40c2-9e3d-a80d424ebeac",
"name": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "8594ad6f-d8f1-457c-8502-9c8f6b887ffc",
"sales_organization_code": "sample string 5"
},
"db_language_id": "5dcea374-a2b9-4611-a5a8-eda6fa33e1f0",
"db_language_code": "sample string 34",
"code": "sample string 35",
"article_price_label_id": "9407dae7-3898-44f1-ba3c-76eee1279a82",
"article_price_label_code": "sample string 37",
"db_payment_method_id": "ddabf20c-b6df-4ea2-8dc2-7eb3cab621f0",
"db_payment_method_reference_back_office": "sample string 39",
"db_payment_methods": {
"id": "e67e4556-eced-4d83-86d8-2c14f276b9a5",
"name": "sample string 2",
"description": "sample string 3",
"reference_back_office": "sample string 4",
"activated": true,
"modified_dateutc": "2025-06-03T08:31:37.8397823+00:00"
},
"company_sector_id": "da639617-68e7-4286-9c89-be9445ca80c1",
"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": "3e337a71-ab1c-404f-8e33-82a5ebe0076f",
"service_manager_user_code": "sample string 52",
"finance_manager_user_id": "eac26587-8d80-4e34-8dc4-81081dec8871",
"finance_manager_user_code": "sample string 54",
"account_manager_user_id": "5996f4d8-a155-4237-9034-9fb72125e2f6",
"account_manager_user_code": "sample string 56",
"company_status_id": "b1e75623-5075-4d02-abb3-16c165718f3e",
"invoice_email_to": "sample string 58",
"modified_dateutc": "2025-06-03T08:31:37.8397823+00:00",
"id2": 60
},
"db_language_id": "f14c14f1-7906-4349-b6c3-30f117b4bbad",
"db_language_code": "sample string 7",
"db_title_id": "b3c18b09-ae79-4e42-ae5f-d9502df615af",
"archived": true,
"functions": "sample string 10",
"e_login": "sample string 11",
"e_password": "sample string 12",
"notes": "sample string 13",
"birthdate": "2025-06-03T08:31:37.8397823+00:00",
"create_date": "2025-06-03T08:31:37.8397823+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-06-03T08:31:37.8397823+00:00"
},
"modified_dateutc": "2025-06-03T08:31:37.8397823+00:00",
"id2": 22
}