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": "a65e170a-7110-42af-8350-76e8cf37e444",
"_parent_id": "e20d0445-baf3-4aed-bd39-fa10dc5c1120",
"_parent_reference_back_office": "sample string 3",
"project_status_id": "ffdc73c4-4e16-45c6-b755-956bc1fd7ffa",
"company_id": "78f566db-8cf2-4bf1-adc1-3c07bd73c11f",
"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": "19798f46-f479-4c65-bd86-e67fde714676",
"db_country_code": "sample string 17",
"street2": "sample string 18",
"latitude_decimal": 1.0,
"longitude_decimal": 1.0,
"contact_id": "71cfafb0-ba27-4c8b-a28e-86d29d41588d",
"contact_reference_back_office": "sample string 20",
"contact": {
"id": "0604b46d-ff04-481b-bd23-9dd0139c074c",
"firstname": "sample string 2",
"lastname": "sample string 3",
"company_id": "c4701633-f93c-46ac-a10a-af6633574bfa",
"company_code": "sample string 5",
"company": {
"id": "f5686569-26e1-49d3-aa9d-d659fe8587d5",
"is_client": true,
"is_supplier": true,
"archived": true,
"name": "sample string 5",
"notes": "sample string 6",
"create_date": "2026-08-29T07:44:51.663246+00:00",
"sales_territory_id": "630424e4-7a6a-4f49-aa08-a709e2b1afed",
"sales_territory_code": "sample string 9",
"sales_territory": {
"id": "c85162fa-6d0f-4c79-98f7-a7ea5b9b4b3b",
"code": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "9716592c-748b-4c2e-9082-d589d2d5d1bb",
"sales_organization_code": "sample string 5",
"sales_organization": {
"id": "f7a14162-151e-45c5-9b8c-aeb000877c8c",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "3a0ce5c0-3e81-45ef-bdfd-621b40dcc62c",
"db_currency_id": "dafbbb5d-54d5-49e3-9744-8e1392c18e5b",
"db_language_id": "13069703-d7c0-4803-b3d6-223b4257bfdf",
"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": "2026-08-29T07:44:51.663246+00:00"
},
"modified_dateutc": "2026-08-29T07:44:51.663246+00:00"
},
"marketing_segment_id": "21c47a01-a5f0-48db-bfad-ac755b7326bd",
"marketing_segment_code": "sample string 11",
"sales_organization_id": "6c6518bf-5c72-4110-b391-96f48cfb96ff",
"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": "c2c2cb26-2d64-4444-b9e7-1ef1478270ad",
"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": "a008a8e3-f1af-455f-ba20-ac3943f045dc",
"db_country_code": "sample string 28",
"feelist_id": "64a2c876-593c-4f7c-8a1e-d54930978453",
"feelist_reference_back_office": "sample string 30",
"feelist": {
"id": "6eb7d152-77f0-46d8-8b69-ce71fa436dfc",
"name": "sample string 2",
"description": "sample string 3",
"is_default": true,
"default_price": 1.0,
"sales_organization_id": "d1010d51-f23b-46b4-89b6-ce44a2ef1285",
"sales_organization_code": "sample string 6",
"reference_back_office": "sample string 7",
"modified_dateutc": "2026-08-29T07:44:51.663246+00:00",
"db_currency_id": "c7fff1df-7e1f-4a94-8881-9a0df6d6ba2a",
"db_currency_code": "sample string 10"
},
"company_type_id": "f41e589e-ad81-4bd9-ba39-5a5d7d3ab853",
"company_type_name": "sample string 32",
"company_type": {
"id": "03bf3118-b785-4504-8d74-e8b6bdc0351e",
"name": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "38700c34-b5cc-4d8c-a8e0-a28615af0197",
"sales_organization_code": "sample string 5"
},
"db_language_id": "1b5ff90c-c8b8-4a08-ace1-487afe5188b2",
"db_language_code": "sample string 34",
"code": "sample string 35",
"article_price_label_id": "f628d837-920d-4748-b8c9-67fb9960e655",
"article_price_label_code": "sample string 37",
"db_payment_method_id": "62097b81-54a9-4e29-b464-46bb00ace053",
"db_payment_method_reference_back_office": "sample string 39",
"db_payment_methods": {
"id": "357d86ba-27a2-47d5-9d75-594dbd518ed5",
"name": "sample string 2",
"description": "sample string 3",
"reference_back_office": "sample string 4",
"activated": true,
"modified_dateutc": "2026-08-29T07:44:51.663246+00:00"
},
"company_sector_id": "b213af76-678d-4ea1-bcdf-f29d609ff7aa",
"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": "f0fa615e-ca8a-4b0d-9cbb-2227d19328b0",
"service_manager_user_code": "sample string 52",
"finance_manager_user_id": "4401d6e2-e9d3-4c19-84d4-c1cb5db1444d",
"finance_manager_user_code": "sample string 54",
"account_manager_user_id": "5cf8aa7f-82f8-4c21-b8a4-98674d3adb26",
"account_manager_user_code": "sample string 56",
"company_status_id": "dabf7eb2-9e9e-4609-bba8-5d0391f6bfd2",
"invoice_email_to": "sample string 58",
"modified_dateutc": "2026-08-29T07:44:51.663246+00:00",
"id2": 60
},
"db_language_id": "c663009c-67b0-41a8-9ad5-3abe2d39409d",
"db_language_code": "sample string 7",
"db_title_id": "8f576660-579a-4c1e-9543-bdfbcc8c501d",
"archived": true,
"functions": "sample string 10",
"e_login": "sample string 11",
"e_password": "sample string 12",
"notes": "sample string 13",
"birthdate": "2026-08-29T07:44:51.663246+00:00",
"create_date": "2026-08-29T07:44:51.663246+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": "2026-08-29T07:44:51.663246+00:00"
},
"modified_dateutc": "2026-08-29T07:44:51.663246+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": "df31bc4a-b820-4cd7-a858-ded9677d5e48",
"_parent_id": "4bc90afd-4e4a-4ad5-8a36-1be25c5290dc",
"_parent_reference_back_office": "sample string 3",
"project_status_id": "f455693b-439e-4f51-bbd8-fcd478114fd6",
"company_id": "798ba529-5fd0-4cb7-9012-9ab17209a14e",
"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": "40ace40e-165e-44e0-bbb6-6421be3bfe75",
"db_country_code": "sample string 17",
"street2": "sample string 18",
"latitude_decimal": 1.0,
"longitude_decimal": 1.0,
"contact_id": "12409def-c0ee-4356-8161-f443b1510f70",
"contact_reference_back_office": "sample string 20",
"contact": {
"id": "101e013b-0371-4cae-9e58-2d2d68ee2747",
"firstname": "sample string 2",
"lastname": "sample string 3",
"company_id": "e45f45b4-67dc-41b9-84cf-be040b35acc5",
"company_code": "sample string 5",
"company": {
"id": "4b0aa822-75d3-47bf-beaf-32801528c5a0",
"is_client": true,
"is_supplier": true,
"archived": true,
"name": "sample string 5",
"notes": "sample string 6",
"create_date": "2026-08-29T07:44:51.663246+00:00",
"sales_territory_id": "d8d0a985-0c46-446f-8e99-54a2a8dc2d53",
"sales_territory_code": "sample string 9",
"sales_territory": {
"id": "782262ac-c961-4e4a-8466-b3e7f4713c39",
"code": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "6f091406-b3a0-4033-9641-37b955dac79c",
"sales_organization_code": "sample string 5",
"sales_organization": {
"id": "ba90501d-035e-4616-b81b-cb5b90edb001",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "eddd1100-253a-471b-a3e9-9753f5447d52",
"db_currency_id": "daeecf1d-0bab-49d1-8a0d-e5e3a26a8f95",
"db_language_id": "4aad3b29-221f-404d-a476-c38aac11b0e7",
"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": "2026-08-29T07:44:51.663246+00:00"
},
"modified_dateutc": "2026-08-29T07:44:51.663246+00:00"
},
"marketing_segment_id": "adff047b-f829-4b0a-a9e6-1ae99f055c7d",
"marketing_segment_code": "sample string 11",
"sales_organization_id": "332a4534-b60c-4220-9d41-4d1dca2305b9",
"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": "4e8b95a8-e46c-481d-8ab7-009ef83015c6",
"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": "df7a3714-18fc-4c87-a97c-a6c3271a1fd7",
"db_country_code": "sample string 28",
"feelist_id": "d0fd630b-51b8-4b6f-8c44-51b9891cff3a",
"feelist_reference_back_office": "sample string 30",
"feelist": {
"id": "8a90e5b6-c6fd-4db4-bdfd-97058f9f6233",
"name": "sample string 2",
"description": "sample string 3",
"is_default": true,
"default_price": 1.0,
"sales_organization_id": "42119423-0fa6-4c99-83d0-48863d6d22ed",
"sales_organization_code": "sample string 6",
"reference_back_office": "sample string 7",
"modified_dateutc": "2026-08-29T07:44:51.663246+00:00",
"db_currency_id": "31117126-bbc5-4151-b60b-3093169ccc68",
"db_currency_code": "sample string 10"
},
"company_type_id": "084f6527-e475-40f5-8727-e09d39c2de20",
"company_type_name": "sample string 32",
"company_type": {
"id": "251b9a1c-5306-4fbf-a0c7-14710b5e0e09",
"name": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "481f474f-858c-4791-bafc-4c5b9d6eb395",
"sales_organization_code": "sample string 5"
},
"db_language_id": "a14a857b-9a90-48f6-bbfd-50d31c8e08ef",
"db_language_code": "sample string 34",
"code": "sample string 35",
"article_price_label_id": "32e3eec8-ae3d-4f59-b849-57b7b763537b",
"article_price_label_code": "sample string 37",
"db_payment_method_id": "fb3f3680-6da4-4875-bf30-3007cd11553e",
"db_payment_method_reference_back_office": "sample string 39",
"db_payment_methods": {
"id": "bad59768-e3a3-4086-b9be-d30d427cca98",
"name": "sample string 2",
"description": "sample string 3",
"reference_back_office": "sample string 4",
"activated": true,
"modified_dateutc": "2026-08-29T07:44:51.663246+00:00"
},
"company_sector_id": "0a4ed61d-0f68-42df-a015-059edbe0c37e",
"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": "2d5e3d00-af49-4864-833e-843b6b66cb51",
"service_manager_user_code": "sample string 52",
"finance_manager_user_id": "9a2877e5-3d66-456e-9d7e-6239428f6873",
"finance_manager_user_code": "sample string 54",
"account_manager_user_id": "b2aa02d2-8b45-471b-908f-8cca14b86c7d",
"account_manager_user_code": "sample string 56",
"company_status_id": "3805d229-2591-443f-b533-12b5358e17c3",
"invoice_email_to": "sample string 58",
"modified_dateutc": "2026-08-29T07:44:51.663246+00:00",
"id2": 60
},
"db_language_id": "e587cbf8-500c-4ee0-9c25-c0e066c59e03",
"db_language_code": "sample string 7",
"db_title_id": "b6f73229-40c6-4920-9180-10c74178d31e",
"archived": true,
"functions": "sample string 10",
"e_login": "sample string 11",
"e_password": "sample string 12",
"notes": "sample string 13",
"birthdate": "2026-08-29T07:44:51.663246+00:00",
"create_date": "2026-08-29T07:44:51.663246+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": "2026-08-29T07:44:51.663246+00:00"
},
"modified_dateutc": "2026-08-29T07:44:51.663246+00:00",
"id2": 22
}