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": "2ce14586-b9d5-42b4-93fc-4171067cf293",
"_parent_id": "7c8d5843-0b89-42be-8fec-21c545e75925",
"_parent_reference_back_office": "sample string 3",
"project_status_id": "2b37b2c4-c259-41b7-af5a-ce4bd95d4f99",
"company_id": "a0263ecd-aeaa-43aa-8365-7795a4d53ab1",
"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": "636cc0a2-8d56-496e-8412-99b5a2992295",
"db_country_code": "sample string 17",
"street2": "sample string 18",
"latitude_decimal": 1.0,
"longitude_decimal": 1.0,
"contact_id": "804bf7d4-e4fe-41bc-b333-08a422fd7760",
"contact_reference_back_office": "sample string 20",
"contact": {
"id": "d8a4b340-0220-4a6f-bd80-ca8380e6d258",
"firstname": "sample string 2",
"lastname": "sample string 3",
"company_id": "8b93f559-57b1-4e95-9bc5-1a5895085275",
"company_code": "sample string 5",
"company": {
"id": "de04f2a8-f3ec-4ed1-89ea-73d8e8a309f1",
"is_client": true,
"is_supplier": true,
"archived": true,
"name": "sample string 5",
"notes": "sample string 6",
"create_date": "2025-09-17T23:56:10.0300987+00:00",
"sales_territory_id": "3f9bbea2-6b1f-4073-9264-fb9a912ac924",
"sales_territory_code": "sample string 9",
"sales_territory": {
"id": "857b62ae-69cd-4bab-bbca-952eacd50358",
"code": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "8d101d41-a9ff-451f-9a6c-36bc99799935",
"sales_organization_code": "sample string 5",
"sales_organization": {
"id": "7bf28f05-6474-4eb8-9e64-414914ad613c",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "f0eed409-901a-4cf9-abd1-7921c0960513",
"db_currency_id": "2f6b5c56-cb1d-4007-b85b-eebaabad5d4e",
"db_language_id": "b9bac965-2d96-4725-8f4a-5998104f4367",
"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-17T23:56:10.0300987+00:00"
},
"modified_dateutc": "2025-09-17T23:56:10.0300987+00:00"
},
"marketing_segment_id": "a21db8fd-0b8e-48d0-9b23-f8aa3b25efef",
"marketing_segment_code": "sample string 11",
"sales_organization_id": "b284ed67-8504-46aa-bf72-a9c8aebd2d32",
"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": "2e670c05-afa7-41df-812d-c9b1a9d35f95",
"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": "2ca51390-de6d-41af-8d7a-5b51f5f4f019",
"db_country_code": "sample string 28",
"feelist_id": "65b56883-7857-47ac-b673-ed3936955361",
"feelist_reference_back_office": "sample string 30",
"feelist": {
"id": "ca72032a-19c8-4581-86b3-38f0a8abaeaa",
"name": "sample string 2",
"description": "sample string 3",
"is_default": true,
"default_price": 1.0,
"sales_organization_id": "74b3edab-0e88-4a59-8a6d-961daecf7963",
"sales_organization_code": "sample string 6",
"reference_back_office": "sample string 7",
"modified_dateutc": "2025-09-17T23:56:10.0300987+00:00",
"db_currency_id": "3a0ae6a8-eb47-4b90-8acf-0f96b3d12398",
"db_currency_code": "sample string 10"
},
"company_type_id": "2abe83a9-59bd-4636-b7f9-6bd7e04f5e87",
"company_type_name": "sample string 32",
"company_type": {
"id": "e7827982-7aea-4260-bea0-6721cbb6d1a2",
"name": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "a2dafa92-6897-41cd-bc8e-ee4d6d5209d2",
"sales_organization_code": "sample string 5"
},
"db_language_id": "1b7343ed-3f4c-4ad5-9a73-f7122866cfaf",
"db_language_code": "sample string 34",
"code": "sample string 35",
"article_price_label_id": "f6e6c149-6f57-45cd-9738-816e06c7de08",
"article_price_label_code": "sample string 37",
"db_payment_method_id": "c501565a-2b13-4385-9eaf-d05360430bf3",
"db_payment_method_reference_back_office": "sample string 39",
"db_payment_methods": {
"id": "42e9f06b-f49f-4129-8ec1-6adc7bfec2bf",
"name": "sample string 2",
"description": "sample string 3",
"reference_back_office": "sample string 4",
"activated": true,
"modified_dateutc": "2025-09-17T23:56:10.0300987+00:00"
},
"company_sector_id": "ea9d1717-7a2e-4b0d-b4b3-5204205cc015",
"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": "9dda080d-9dd8-4f65-a39d-15047300988b",
"service_manager_user_code": "sample string 52",
"finance_manager_user_id": "e33933f6-d91a-461d-b11a-c98fce6ce429",
"finance_manager_user_code": "sample string 54",
"account_manager_user_id": "9673b738-3f73-4d84-af97-843945e9da0c",
"account_manager_user_code": "sample string 56",
"company_status_id": "1db65e6e-c629-402d-82af-102ebb9e89e1",
"invoice_email_to": "sample string 58",
"modified_dateutc": "2025-09-17T23:56:10.0300987+00:00",
"id2": 60
},
"db_language_id": "54eee2fb-c8d9-4502-bc43-9d234416a867",
"db_language_code": "sample string 7",
"db_title_id": "7ff5991a-046a-4230-bdfd-944fdddfcd69",
"archived": true,
"functions": "sample string 10",
"e_login": "sample string 11",
"e_password": "sample string 12",
"notes": "sample string 13",
"birthdate": "2025-09-17T23:56:10.0300987+00:00",
"create_date": "2025-09-17T23:56:10.0300987+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-17T23:56:10.0300987+00:00"
},
"modified_dateutc": "2025-09-17T23:56:10.0300987+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": "e58b5bf0-f3fd-4acd-bdd8-d25145813b18",
"_parent_id": "3420bba6-eea0-4d51-80c5-b7eed8051042",
"_parent_reference_back_office": "sample string 3",
"project_status_id": "89b729e8-8dda-4835-8a76-bcf231e93bb4",
"company_id": "762ab0e5-19ad-43d7-9976-0a853cf2243a",
"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": "c71e49df-b1f3-4fd8-85e2-6519e695d6a2",
"db_country_code": "sample string 17",
"street2": "sample string 18",
"latitude_decimal": 1.0,
"longitude_decimal": 1.0,
"contact_id": "b5ae7594-804b-4305-a848-d633bd4c4884",
"contact_reference_back_office": "sample string 20",
"contact": {
"id": "0e911ca7-c056-4593-a572-ab27243227d9",
"firstname": "sample string 2",
"lastname": "sample string 3",
"company_id": "dd8b0c18-09fb-4e64-bc63-515e7da147f0",
"company_code": "sample string 5",
"company": {
"id": "27028687-9ebf-4bf0-9634-acdea632d228",
"is_client": true,
"is_supplier": true,
"archived": true,
"name": "sample string 5",
"notes": "sample string 6",
"create_date": "2025-09-17T23:56:10.0457223+00:00",
"sales_territory_id": "66424f50-bfeb-452f-b0fd-7d29c499cf82",
"sales_territory_code": "sample string 9",
"sales_territory": {
"id": "d96d6967-9118-4271-906a-fbdc4a7543cc",
"code": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "7731413f-8224-49aa-bdeb-b5106e727fda",
"sales_organization_code": "sample string 5",
"sales_organization": {
"id": "470002ec-e0d0-47e5-8274-f6edd511a1f2",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "b534c4c9-adcb-47f4-a9c5-fac388a56943",
"db_currency_id": "d0f81115-afdf-497b-93f1-bfab86cb4084",
"db_language_id": "d38ef502-aba4-43c0-b502-1a76c5e66f9b",
"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-17T23:56:10.0457223+00:00"
},
"modified_dateutc": "2025-09-17T23:56:10.0457223+00:00"
},
"marketing_segment_id": "b6a8f9d7-7b03-47d5-8b14-82c2064cebf3",
"marketing_segment_code": "sample string 11",
"sales_organization_id": "c0c502cb-6fe4-4df9-b7a3-ee5ece67ecb6",
"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": "37fe9777-86c8-4f8a-950c-4ba650924c9f",
"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": "788d0114-ba9a-4a53-b185-22ab9a573df9",
"db_country_code": "sample string 28",
"feelist_id": "c555eee2-699e-4e45-a4a1-531273530664",
"feelist_reference_back_office": "sample string 30",
"feelist": {
"id": "d31610eb-b186-454d-abee-70c12cd47157",
"name": "sample string 2",
"description": "sample string 3",
"is_default": true,
"default_price": 1.0,
"sales_organization_id": "2631be10-8bbc-4d42-a582-216ace26ce1d",
"sales_organization_code": "sample string 6",
"reference_back_office": "sample string 7",
"modified_dateutc": "2025-09-17T23:56:10.0457223+00:00",
"db_currency_id": "85ee1e1b-8cba-4589-b586-055a86c15cea",
"db_currency_code": "sample string 10"
},
"company_type_id": "6ab44cfd-2c15-4369-aaff-6c045af065b9",
"company_type_name": "sample string 32",
"company_type": {
"id": "f12ea979-dc6c-45bc-82d5-70b67743e719",
"name": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "ba092d3c-8225-469b-b5e7-ddc6f56fb60e",
"sales_organization_code": "sample string 5"
},
"db_language_id": "ef0f70d4-c4e3-4e8e-a0bb-07e83ba7042b",
"db_language_code": "sample string 34",
"code": "sample string 35",
"article_price_label_id": "12bd135b-e886-4fc5-9bc2-c1648c3d7f50",
"article_price_label_code": "sample string 37",
"db_payment_method_id": "b117baed-f2c8-4fdb-9ae5-62985d5ce64f",
"db_payment_method_reference_back_office": "sample string 39",
"db_payment_methods": {
"id": "a056cd4d-af58-4df3-9e30-58125284b513",
"name": "sample string 2",
"description": "sample string 3",
"reference_back_office": "sample string 4",
"activated": true,
"modified_dateutc": "2025-09-17T23:56:10.0457223+00:00"
},
"company_sector_id": "95dafdf7-b355-4cb9-8799-e55d4e8532d7",
"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": "c5935fce-d410-42e8-bcd4-15be024c1c69",
"service_manager_user_code": "sample string 52",
"finance_manager_user_id": "2d1c7b05-3b66-47bf-96cc-34f3998c00ba",
"finance_manager_user_code": "sample string 54",
"account_manager_user_id": "f0eb9acc-6378-490d-b3ba-3caacc1f4ce0",
"account_manager_user_code": "sample string 56",
"company_status_id": "2ce7b70f-89d5-487f-90b4-95a504219a5e",
"invoice_email_to": "sample string 58",
"modified_dateutc": "2025-09-17T23:56:10.0457223+00:00",
"id2": 60
},
"db_language_id": "01d85bdd-c60e-4330-beb7-478c2facf1d5",
"db_language_code": "sample string 7",
"db_title_id": "4587dfb5-fb3a-4abf-b412-dfa91b1f5020",
"archived": true,
"functions": "sample string 10",
"e_login": "sample string 11",
"e_password": "sample string 12",
"notes": "sample string 13",
"birthdate": "2025-09-17T23:56:10.0457223+00:00",
"create_date": "2025-09-17T23:56:10.0457223+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-17T23:56:10.0457223+00:00"
},
"modified_dateutc": "2025-09-17T23:56:10.0457223+00:00",
"id2": 22
}