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": "bf901e43-5b1f-4893-be02-51f7b60e187f",
"_parent_id": "8cbc18c3-e1af-4267-a86a-f05a72dc1c61",
"_parent_reference_back_office": "sample string 3",
"project_status_id": "102e5526-3d3c-4336-a183-77bbe5a61479",
"company_id": "621cd84d-1e2d-4fc6-8c10-c30611cf9061",
"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": "d11aade3-8276-4f7b-8fe9-27e8984117b2",
"db_country_code": "sample string 17",
"street2": "sample string 18",
"latitude_decimal": 1.0,
"longitude_decimal": 1.0,
"contact_id": "22d6d6c2-52b3-4d9a-a3d2-8f8b68cb8668",
"contact_reference_back_office": "sample string 20",
"contact": {
"id": "fb06877a-fcba-4c8b-9250-b85a78082a43",
"firstname": "sample string 2",
"lastname": "sample string 3",
"company_id": "665019d0-0634-49b9-9dee-5109151a6ee6",
"company_code": "sample string 5",
"company": {
"id": "45decaeb-9e33-404d-a626-36eea8a5f5ba",
"is_client": true,
"is_supplier": true,
"archived": true,
"name": "sample string 5",
"notes": "sample string 6",
"create_date": "2026-01-17T03:46:50.1540076+00:00",
"sales_territory_id": "4ab6719f-425a-4980-b288-63e264ceba64",
"sales_territory_code": "sample string 9",
"sales_territory": {
"id": "f35522d6-870b-429d-b4a0-77fff656d114",
"code": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "fffaa8e1-599c-4e7c-b412-63d025ae3fc3",
"sales_organization_code": "sample string 5",
"sales_organization": {
"id": "149b3058-d145-4c83-a88f-630b5edfc1bb",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "4f8d5454-0ba1-411b-ab4f-9bb51922a867",
"db_currency_id": "0840e866-63f2-493a-82f7-d473e86418e0",
"db_language_id": "61169ffd-2dde-4ff0-b96a-a066aeaea19d",
"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-01-17T03:46:50.1696238+00:00"
},
"modified_dateutc": "2026-01-17T03:46:50.1696238+00:00"
},
"marketing_segment_id": "3e900997-5250-4f02-b2f3-ca2ab0da560c",
"marketing_segment_code": "sample string 11",
"sales_organization_id": "19f3492e-d51c-48da-bf24-d43569ca33f8",
"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": "c26dc369-8341-4a77-89ac-48a22567a134",
"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": "6dd738da-49ce-43aa-a8b3-f67c2216ee82",
"db_country_code": "sample string 28",
"feelist_id": "0af8f557-6c57-4f88-b317-8dfb4d33937c",
"feelist_reference_back_office": "sample string 30",
"feelist": {
"id": "f958aa91-ae5c-4d81-8ed0-0c045bba24e7",
"name": "sample string 2",
"description": "sample string 3",
"is_default": true,
"default_price": 1.0,
"sales_organization_id": "ac55d410-e21d-49d0-8d08-eb3ad361f66b",
"sales_organization_code": "sample string 6",
"reference_back_office": "sample string 7",
"modified_dateutc": "2026-01-17T03:46:50.1696238+00:00",
"db_currency_id": "bb0ca352-9e1c-48e6-9b07-bf84de68e233",
"db_currency_code": "sample string 10"
},
"company_type_id": "b9585e5e-b090-4388-a0c2-4d8a4047e575",
"company_type_name": "sample string 32",
"company_type": {
"id": "a53ebdbe-fb3c-4782-b901-1f93de741c7b",
"name": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "f84bad34-e0e1-4d5a-b189-c8619cafd7dd",
"sales_organization_code": "sample string 5"
},
"db_language_id": "d0e2d38e-daa7-4d9e-9ea0-12392c20ca0e",
"db_language_code": "sample string 34",
"code": "sample string 35",
"article_price_label_id": "fa276986-5148-41d5-9ff9-1f50c9776e02",
"article_price_label_code": "sample string 37",
"db_payment_method_id": "1f866a32-1fd9-4157-8204-2f198a23c390",
"db_payment_method_reference_back_office": "sample string 39",
"db_payment_methods": {
"id": "072c7efa-0141-4344-85c6-14c92ddb2457",
"name": "sample string 2",
"description": "sample string 3",
"reference_back_office": "sample string 4",
"activated": true,
"modified_dateutc": "2026-01-17T03:46:50.1696238+00:00"
},
"company_sector_id": "c8ff7d8d-5beb-4d47-a37f-239d9d239392",
"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": "27b97c6c-aa60-4579-90c4-4730ad7bc97a",
"service_manager_user_code": "sample string 52",
"finance_manager_user_id": "7e094e5b-0e73-488f-bf5e-aca82232b104",
"finance_manager_user_code": "sample string 54",
"account_manager_user_id": "e8df7f78-914b-4a6e-9dd9-73f1ed86840f",
"account_manager_user_code": "sample string 56",
"company_status_id": "7e11a129-715e-4cf5-b4b9-0e58c3051c98",
"invoice_email_to": "sample string 58",
"modified_dateutc": "2026-01-17T03:46:50.1696238+00:00",
"id2": 60
},
"db_language_id": "85eea5d5-e37f-4a20-816c-03e01d091f51",
"db_language_code": "sample string 7",
"db_title_id": "f29bbf77-0167-400c-9c1a-259bff00e55e",
"archived": true,
"functions": "sample string 10",
"e_login": "sample string 11",
"e_password": "sample string 12",
"notes": "sample string 13",
"birthdate": "2026-01-17T03:46:50.1696238+00:00",
"create_date": "2026-01-17T03:46:50.1696238+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-01-17T03:46:50.1696238+00:00"
},
"modified_dateutc": "2026-01-17T03:46:50.1696238+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": "e0403d1c-1c6c-4860-bd62-470ab127ad66",
"_parent_id": "81792537-1b73-422a-ad3d-1a82644aa121",
"_parent_reference_back_office": "sample string 3",
"project_status_id": "977c7679-5c78-4997-88c2-0fb799cfa213",
"company_id": "a74bacef-e9b9-4f79-8192-5899a5b54b1d",
"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": "e1004373-9550-4e3d-a6b5-3575e949ce09",
"db_country_code": "sample string 17",
"street2": "sample string 18",
"latitude_decimal": 1.0,
"longitude_decimal": 1.0,
"contact_id": "ce67e3f5-58bb-49cf-9ff5-991b855ff58b",
"contact_reference_back_office": "sample string 20",
"contact": {
"id": "38b89ea3-1bd1-49a8-82f4-31fb19a9a907",
"firstname": "sample string 2",
"lastname": "sample string 3",
"company_id": "de67722d-b859-4b83-a50d-ec0554c4c62b",
"company_code": "sample string 5",
"company": {
"id": "0cc45d5f-6e9e-429f-9743-fed702783ec6",
"is_client": true,
"is_supplier": true,
"archived": true,
"name": "sample string 5",
"notes": "sample string 6",
"create_date": "2026-01-17T03:46:50.1696238+00:00",
"sales_territory_id": "c6892e00-b94a-44f9-ac35-87a34d1fe7f8",
"sales_territory_code": "sample string 9",
"sales_territory": {
"id": "dec13ae9-64d0-4724-8418-1cc0f1556d06",
"code": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "d818f51a-5ddd-49c3-b5c4-439100dc8d6a",
"sales_organization_code": "sample string 5",
"sales_organization": {
"id": "2a5059c3-93aa-4c3d-9a22-7ee8eea9580e",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "eb8965e2-1a68-471a-b1c8-09a2b00658fc",
"db_currency_id": "47fd682b-bb0a-4306-ba64-9c1557894670",
"db_language_id": "22db86c5-3541-4ea4-a2db-8db137ad582e",
"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-01-17T03:46:50.1696238+00:00"
},
"modified_dateutc": "2026-01-17T03:46:50.1696238+00:00"
},
"marketing_segment_id": "566ef404-1ea0-4a0f-94ae-0f749b490f6f",
"marketing_segment_code": "sample string 11",
"sales_organization_id": "7d554ac6-74e8-4158-8d1e-d9335a39a6e3",
"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": "8e9c3475-66f5-4ede-a233-c40afdddc85b",
"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": "b189dae2-7b7b-44a8-9b24-a97f0e44357e",
"db_country_code": "sample string 28",
"feelist_id": "8d395586-bd8b-4660-a22d-0b62e0947947",
"feelist_reference_back_office": "sample string 30",
"feelist": {
"id": "ef281667-3ab8-44f4-a8db-b03bfafe6a1b",
"name": "sample string 2",
"description": "sample string 3",
"is_default": true,
"default_price": 1.0,
"sales_organization_id": "0aed6a46-23d9-4046-b4c5-2e0b9b9715a4",
"sales_organization_code": "sample string 6",
"reference_back_office": "sample string 7",
"modified_dateutc": "2026-01-17T03:46:50.1696238+00:00",
"db_currency_id": "356043c6-248b-4673-9914-2b8db520c7f2",
"db_currency_code": "sample string 10"
},
"company_type_id": "f3617224-5247-4ceb-a60c-d7e65073729d",
"company_type_name": "sample string 32",
"company_type": {
"id": "9933f4d1-6844-4c90-b833-6f616b27dffb",
"name": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "a7f49cca-6259-4df8-a91c-f15c9b876c65",
"sales_organization_code": "sample string 5"
},
"db_language_id": "a3f65d40-96bf-4d16-8ec8-149e637a0f05",
"db_language_code": "sample string 34",
"code": "sample string 35",
"article_price_label_id": "3b1a0ed8-678a-4072-9fa3-38564bff0e76",
"article_price_label_code": "sample string 37",
"db_payment_method_id": "65906b1c-74ec-437f-86a9-ea944b25b6ba",
"db_payment_method_reference_back_office": "sample string 39",
"db_payment_methods": {
"id": "70a5e441-5b83-466b-be3a-4ede4c9fa9d8",
"name": "sample string 2",
"description": "sample string 3",
"reference_back_office": "sample string 4",
"activated": true,
"modified_dateutc": "2026-01-17T03:46:50.1696238+00:00"
},
"company_sector_id": "8adf052d-96d9-445b-9922-c9ea11833aeb",
"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": "88d5e121-65a3-4527-801c-615e96b64ae9",
"service_manager_user_code": "sample string 52",
"finance_manager_user_id": "2c47535e-fda3-4676-af35-020e5e5871e8",
"finance_manager_user_code": "sample string 54",
"account_manager_user_id": "25a2ebb2-744a-4abd-9e77-6f8bda2a5c2a",
"account_manager_user_code": "sample string 56",
"company_status_id": "b50f2469-efa6-44fe-a063-b8ba07672d00",
"invoice_email_to": "sample string 58",
"modified_dateutc": "2026-01-17T03:46:50.1696238+00:00",
"id2": 60
},
"db_language_id": "ac342b7d-78c7-47ee-99ae-18a9b8b442c8",
"db_language_code": "sample string 7",
"db_title_id": "5b76b392-6fe8-42af-a80e-9c9ef01f3ec7",
"archived": true,
"functions": "sample string 10",
"e_login": "sample string 11",
"e_password": "sample string 12",
"notes": "sample string 13",
"birthdate": "2026-01-17T03:46:50.1696238+00:00",
"create_date": "2026-01-17T03:46:50.1696238+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-01-17T03:46:50.1696238+00:00"
},
"modified_dateutc": "2026-01-17T03:46:50.1696238+00:00",
"id2": 22
}