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": "b5a4da4d-2286-4059-a98d-a07a066b7a68",
"_parent_id": "7f65e6a3-d4bd-4a20-9b19-d2daa6041a72",
"_parent_reference_back_office": "sample string 3",
"project_status_id": "9b20af2b-dd75-4cdc-b0e3-0b4562717aae",
"company_id": "7b2d5e8a-8daf-418f-b632-672306a9528a",
"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": "a1133615-4887-4a9d-8d25-22d92e38d29a",
"db_country_code": "sample string 17",
"street2": "sample string 18",
"latitude_decimal": 1.0,
"longitude_decimal": 1.0,
"contact_id": "8b48d496-5ce2-438f-890a-32c7481790c4",
"contact_reference_back_office": "sample string 20",
"contact": {
"id": "342f8b5a-8794-475c-90a7-8be25a04a471",
"firstname": "sample string 2",
"lastname": "sample string 3",
"company_id": "75220d70-61ce-4ea1-9492-2552bda07f61",
"company_code": "sample string 5",
"company": {
"id": "d5363d22-9410-4c2a-a7e4-696cc90ed584",
"is_client": true,
"is_supplier": true,
"archived": true,
"name": "sample string 5",
"notes": "sample string 6",
"create_date": "2025-06-25T18:48:32.8005529+00:00",
"sales_territory_id": "0855d461-558e-4e05-abdb-1851f4a1ff01",
"sales_territory_code": "sample string 9",
"sales_territory": {
"id": "eccc6d5a-aeb0-43a7-9a66-ea65f3330503",
"code": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "b6cb4cc6-f933-4911-8169-f101854e6c7c",
"sales_organization_code": "sample string 5",
"sales_organization": {
"id": "7f97c714-4048-4cf9-a10e-a42ffcf3d850",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "57b76e49-3d7d-4f0b-9e6f-d04ea2078cc1",
"db_currency_id": "f0df1b37-b768-478f-bb5b-4aefa3a76c02",
"db_language_id": "e4edb2df-c9d5-429d-8b41-6f1caf0dc6d8",
"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-25T18:48:32.8005529+00:00"
},
"modified_dateutc": "2025-06-25T18:48:32.8005529+00:00"
},
"marketing_segment_id": "f2a1f4cf-21ed-4f80-8f84-fd77d34815ac",
"marketing_segment_code": "sample string 11",
"sales_organization_id": "41d9da79-a0ac-4bd9-a9d2-2f996f749d66",
"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": "71757de7-a6be-4bdf-917d-dbde90b1fdca",
"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": "4ef203be-349c-4433-bc76-ccce77333aba",
"db_country_code": "sample string 28",
"feelist_id": "db8f648e-9f04-4a74-84b1-805e318d93fd",
"feelist_reference_back_office": "sample string 30",
"feelist": {
"id": "1096a612-c872-4a68-a2f2-8b5bf6da2d0e",
"name": "sample string 2",
"description": "sample string 3",
"is_default": true,
"default_price": 1.0,
"sales_organization_id": "435ab96d-50f1-4c64-9f8f-d8f0366b3c3c",
"sales_organization_code": "sample string 6",
"reference_back_office": "sample string 7",
"modified_dateutc": "2025-06-25T18:48:32.8005529+00:00",
"db_currency_id": "1432f59a-ba9f-4787-9aed-e6bb7dd73b70",
"db_currency_code": "sample string 10"
},
"company_type_id": "bbac9e89-05ff-4026-a7cb-7f95f77732fe",
"company_type_name": "sample string 32",
"company_type": {
"id": "dc037cde-2a7d-4924-a502-e8e12e70e68d",
"name": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "5f13d994-4bab-4615-8589-589ff8981a14",
"sales_organization_code": "sample string 5"
},
"db_language_id": "5c48efb0-dcae-40e0-945a-2f880a9d907b",
"db_language_code": "sample string 34",
"code": "sample string 35",
"article_price_label_id": "7f1c5dc8-a8b5-4c53-b406-a4f2cab4e002",
"article_price_label_code": "sample string 37",
"db_payment_method_id": "d1b29c40-9d07-4da2-a93d-f54003fb4fcd",
"db_payment_method_reference_back_office": "sample string 39",
"db_payment_methods": {
"id": "39424277-b63d-4b89-8f66-3172f8d47747",
"name": "sample string 2",
"description": "sample string 3",
"reference_back_office": "sample string 4",
"activated": true,
"modified_dateutc": "2025-06-25T18:48:32.8005529+00:00"
},
"company_sector_id": "1d13a113-10ae-408e-bc3b-14a54f273042",
"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": "c0bf8e88-bbbb-42a5-bfe0-1c9ef9a8d732",
"service_manager_user_code": "sample string 52",
"finance_manager_user_id": "7fa3748a-3ba9-42ac-b749-70098a10cff4",
"finance_manager_user_code": "sample string 54",
"account_manager_user_id": "0a9aaa62-d6d6-4338-b964-922f60bc03d4",
"account_manager_user_code": "sample string 56",
"company_status_id": "bd0eb9c6-510e-4d62-ab82-2b377b790a5a",
"invoice_email_to": "sample string 58",
"modified_dateutc": "2025-06-25T18:48:32.8005529+00:00",
"id2": 60
},
"db_language_id": "84485f2e-c4eb-4976-a19d-a983bc7d3e91",
"db_language_code": "sample string 7",
"db_title_id": "aa03e61d-f31c-472a-bfdd-17727d11ae4a",
"archived": true,
"functions": "sample string 10",
"e_login": "sample string 11",
"e_password": "sample string 12",
"notes": "sample string 13",
"birthdate": "2025-06-25T18:48:32.8005529+00:00",
"create_date": "2025-06-25T18:48:32.8005529+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-25T18:48:32.8005529+00:00"
},
"modified_dateutc": "2025-06-25T18:48:32.8005529+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": "760ebc29-7f0e-44a8-85cb-07e661ff41e5",
"_parent_id": "ab2b52b6-70b9-4b4f-bccf-31cc68611f81",
"_parent_reference_back_office": "sample string 3",
"project_status_id": "6179380a-ca81-470d-ac63-56efff7e4e10",
"company_id": "3e1d5a6e-776a-4b19-8edf-44579ca22dd1",
"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": "bace9b9c-2d84-4085-8c83-b398faeeb374",
"db_country_code": "sample string 17",
"street2": "sample string 18",
"latitude_decimal": 1.0,
"longitude_decimal": 1.0,
"contact_id": "09de51c4-f13b-464c-971f-bf8bcdae4400",
"contact_reference_back_office": "sample string 20",
"contact": {
"id": "0e9edb6a-265e-477a-b55d-2341aede0cbc",
"firstname": "sample string 2",
"lastname": "sample string 3",
"company_id": "7810adfb-b195-45da-a580-bdb87276ed81",
"company_code": "sample string 5",
"company": {
"id": "227ec7da-fee7-406e-812a-d410c5176c56",
"is_client": true,
"is_supplier": true,
"archived": true,
"name": "sample string 5",
"notes": "sample string 6",
"create_date": "2025-06-25T18:48:32.8005529+00:00",
"sales_territory_id": "57483d07-da99-4b2f-b036-6853515dc414",
"sales_territory_code": "sample string 9",
"sales_territory": {
"id": "5f2d7f5b-3b9d-4969-baca-0831689e3864",
"code": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "64eeebca-526d-4d75-9cc6-2637e297d139",
"sales_organization_code": "sample string 5",
"sales_organization": {
"id": "89d28af3-196b-41df-b134-64291bd105a0",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "d41fd83b-b1d0-41a5-b11c-fe56f58b04fa",
"db_currency_id": "9c918ce1-36e0-46e3-a4f2-e6850575ac3f",
"db_language_id": "35b0ed61-9ce1-411a-ad31-93c8282f537c",
"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-25T18:48:32.8005529+00:00"
},
"modified_dateutc": "2025-06-25T18:48:32.8005529+00:00"
},
"marketing_segment_id": "9f131ff2-8bb6-479c-8ec3-e1163dae03ee",
"marketing_segment_code": "sample string 11",
"sales_organization_id": "71256891-2b92-47d9-ae34-3a95ccf6922d",
"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": "35621d07-7957-44d6-8f2d-ce018d683e65",
"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": "78ea50d5-08fd-4330-8d40-cc90a51ae503",
"db_country_code": "sample string 28",
"feelist_id": "7e07c519-5dad-4a98-a746-92bfc9de8923",
"feelist_reference_back_office": "sample string 30",
"feelist": {
"id": "2821284b-83bc-4fd7-9fbb-7b62d3aa87c0",
"name": "sample string 2",
"description": "sample string 3",
"is_default": true,
"default_price": 1.0,
"sales_organization_id": "e1c76231-7a05-4a6e-8a00-40b3ad6febe7",
"sales_organization_code": "sample string 6",
"reference_back_office": "sample string 7",
"modified_dateutc": "2025-06-25T18:48:32.8005529+00:00",
"db_currency_id": "31a65ba4-438c-45f5-af66-57b37ffacfc7",
"db_currency_code": "sample string 10"
},
"company_type_id": "55993e10-5bbb-443c-bfed-5206e6f0370a",
"company_type_name": "sample string 32",
"company_type": {
"id": "9dfc407a-b54f-4ea4-b1b9-37691b0536c5",
"name": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "d78c2563-b729-4b0f-8b49-b9f3adbc0a2a",
"sales_organization_code": "sample string 5"
},
"db_language_id": "48dd9fc5-438b-4be0-a0f9-9fcf52a58d86",
"db_language_code": "sample string 34",
"code": "sample string 35",
"article_price_label_id": "3f61fdd0-7ba1-4d4a-9f76-d07f6447e2f6",
"article_price_label_code": "sample string 37",
"db_payment_method_id": "34b683fc-8ef8-46f7-b405-a8dd0d8199b7",
"db_payment_method_reference_back_office": "sample string 39",
"db_payment_methods": {
"id": "8fd5730c-d991-483d-bbcd-69ad0a2d061b",
"name": "sample string 2",
"description": "sample string 3",
"reference_back_office": "sample string 4",
"activated": true,
"modified_dateutc": "2025-06-25T18:48:32.8005529+00:00"
},
"company_sector_id": "a36d6544-a500-4899-87d0-36d1a43680ac",
"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": "784e7537-4794-4046-92b0-5cfa2e2f1835",
"service_manager_user_code": "sample string 52",
"finance_manager_user_id": "7ea83b59-c342-4657-87da-260fd789639b",
"finance_manager_user_code": "sample string 54",
"account_manager_user_id": "393f8501-29ed-4db8-b910-c92d3be85653",
"account_manager_user_code": "sample string 56",
"company_status_id": "155a8e85-9e3e-476a-962e-9a006492e32f",
"invoice_email_to": "sample string 58",
"modified_dateutc": "2025-06-25T18:48:32.8005529+00:00",
"id2": 60
},
"db_language_id": "ff34ee77-5490-4be1-a1ed-b31e586489a3",
"db_language_code": "sample string 7",
"db_title_id": "5b58b292-562e-4002-b0f9-b50bb1d02ea2",
"archived": true,
"functions": "sample string 10",
"e_login": "sample string 11",
"e_password": "sample string 12",
"notes": "sample string 13",
"birthdate": "2025-06-25T18:48:32.8005529+00:00",
"create_date": "2025-06-25T18:48:32.8005529+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-25T18:48:32.8161785+00:00"
},
"modified_dateutc": "2025-06-25T18:48:32.8161785+00:00",
"id2": 22
}