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": "7043f1ba-49cf-4db1-a8e6-0842ca308b52",
"_parent_id": "29c865d7-371e-4a68-b3f2-323f63cfd1f5",
"_parent_reference_back_office": "sample string 3",
"project_status_id": "ed0f1c69-6801-48fa-97ac-0c3060dd9a9e",
"company_id": "7ed0491b-86a7-4d10-8e93-0fd118d8d45a",
"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": "e23bbd47-7dbc-4517-ada7-e925254f7ef2",
"db_country_code": "sample string 17",
"street2": "sample string 18",
"latitude_decimal": 1.0,
"longitude_decimal": 1.0,
"contact_id": "fb51acaa-cf83-41ec-ba47-a311b6c30e5f",
"contact_reference_back_office": "sample string 20",
"contact": {
"id": "7dad8e55-598f-417f-be8e-1265bc9e33d6",
"firstname": "sample string 2",
"lastname": "sample string 3",
"company_id": "4405087f-5a49-4528-b29c-62eb79692a94",
"company_code": "sample string 5",
"company": {
"id": "13b54e5e-8b4d-41ec-a3e9-0b377d64c07e",
"is_client": true,
"is_supplier": true,
"archived": true,
"name": "sample string 5",
"notes": "sample string 6",
"create_date": "2025-03-23T02:44:08.4810923+00:00",
"sales_territory_id": "e2400af9-36fd-4f60-a7ca-7d46787844c9",
"sales_territory_code": "sample string 9",
"sales_territory": {
"id": "2f92faf1-fa3a-4e98-afb3-28217ba91ddb",
"code": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "0a4e6ea8-7e9f-44eb-b3f9-0a7cc0f0fbce",
"sales_organization_code": "sample string 5",
"sales_organization": {
"id": "82b986f3-f0b3-45da-82d2-ccfdc0b2d5ce",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "587cb654-85df-47f8-abba-83db7e26b5ea",
"db_currency_id": "dcd64d9a-b4a7-4cbd-bf6d-2b72416d7d23",
"db_language_id": "0ea03008-84d5-41ab-bf6e-ea6155244534",
"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-03-23T02:44:08.4810923+00:00"
},
"modified_dateutc": "2025-03-23T02:44:08.4810923+00:00"
},
"marketing_segment_id": "5d7f19b3-1726-41fd-b4ae-f9759fa630b5",
"marketing_segment_code": "sample string 11",
"sales_organization_id": "69ea9473-ac17-4a0c-bd34-1636a378f461",
"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": "4fd75c46-0b23-4703-9202-adf3aa2fd97c",
"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": "3f4fbda9-f66d-49a9-93c9-88b72d7353b1",
"db_country_code": "sample string 28",
"feelist_id": "eddd877a-327a-4fd9-988b-071e1c3d2669",
"feelist_reference_back_office": "sample string 30",
"feelist": {
"id": "662ed6e4-4599-477f-a78b-55b272d7faf8",
"name": "sample string 2",
"description": "sample string 3",
"is_default": true,
"default_price": 1.0,
"sales_organization_id": "fbdced85-992e-44e4-be3b-c095eecf87ab",
"sales_organization_code": "sample string 6",
"reference_back_office": "sample string 7",
"modified_dateutc": "2025-03-23T02:44:08.4810923+00:00",
"db_currency_id": "d0864fcf-d377-4c42-af9d-d9fb0f18d001",
"db_currency_code": "sample string 10"
},
"company_type_id": "faead880-b284-4a84-b457-d1382fe187db",
"company_type_name": "sample string 32",
"company_type": {
"id": "6f04f650-7823-4ddc-a984-8718e4d279b3",
"name": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "a0af7595-47a8-4f64-b665-594093065a98",
"sales_organization_code": "sample string 5"
},
"db_language_id": "430e126a-0e4a-4ea6-800f-6df656eb24ce",
"db_language_code": "sample string 34",
"code": "sample string 35",
"article_price_label_id": "eb7a26d3-7ca1-4fb2-b65e-af51d2667c91",
"article_price_label_code": "sample string 37",
"db_payment_method_id": "d2a43aec-0b02-47d8-87ce-bcbed4ba9306",
"db_payment_method_reference_back_office": "sample string 39",
"db_payment_methods": {
"id": "6b79f757-45d3-4e8b-ab17-f91b9117cdc6",
"name": "sample string 2",
"description": "sample string 3",
"reference_back_office": "sample string 4",
"activated": true,
"modified_dateutc": "2025-03-23T02:44:08.4810923+00:00"
},
"company_sector_id": "cf68b123-3117-4504-9427-89151b7a757f",
"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": "74a839c2-f46e-4156-a749-a9f0c78e60ce",
"service_manager_user_code": "sample string 52",
"finance_manager_user_id": "fb5174aa-b1df-4685-a3a7-fe5a7c8b2a9a",
"finance_manager_user_code": "sample string 54",
"account_manager_user_id": "e438f682-febc-4992-94ed-e7b59f0363ac",
"account_manager_user_code": "sample string 56",
"company_status_id": "21058ddc-f551-41ec-b280-9ec0239a094d",
"invoice_email_to": "sample string 58",
"modified_dateutc": "2025-03-23T02:44:08.4810923+00:00",
"id2": 60
},
"db_language_id": "ac2bda8a-a7e5-45de-8162-d032d44ee202",
"db_language_code": "sample string 7",
"db_title_id": "f7aa98ba-7515-4c74-815e-9551ecb67fd8",
"archived": true,
"functions": "sample string 10",
"e_login": "sample string 11",
"e_password": "sample string 12",
"notes": "sample string 13",
"birthdate": "2025-03-23T02:44:08.4967149+00:00",
"create_date": "2025-03-23T02:44:08.4967149+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-03-23T02:44:08.4967149+00:00"
},
"modified_dateutc": "2025-03-23T02:44:08.4967149+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": "952e3ca9-84d5-4827-a986-77d574700117",
"_parent_id": "639b233c-9c09-4569-8478-f77203602eb5",
"_parent_reference_back_office": "sample string 3",
"project_status_id": "d82b7967-ba96-4b7e-8652-cff6ec6a2343",
"company_id": "dc70681b-df45-4dc6-846c-77d05b276bc6",
"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": "150c4d12-34df-483d-bdba-8a77bcfdcd82",
"db_country_code": "sample string 17",
"street2": "sample string 18",
"latitude_decimal": 1.0,
"longitude_decimal": 1.0,
"contact_id": "780cdbf3-c668-4ec5-bcc8-0a1ac9abd7e7",
"contact_reference_back_office": "sample string 20",
"contact": {
"id": "71ced4f5-727d-4025-94d0-fd0827b38ee8",
"firstname": "sample string 2",
"lastname": "sample string 3",
"company_id": "9de396dd-df85-4865-b514-1ced45732e17",
"company_code": "sample string 5",
"company": {
"id": "32285b2f-384d-46db-a0c7-bce4d1df6111",
"is_client": true,
"is_supplier": true,
"archived": true,
"name": "sample string 5",
"notes": "sample string 6",
"create_date": "2025-03-23T02:44:08.5904485+00:00",
"sales_territory_id": "daaadc6e-0367-42cb-8b7a-7e66c420541c",
"sales_territory_code": "sample string 9",
"sales_territory": {
"id": "79184f9f-354a-4528-ae9d-eddcdeeef659",
"code": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "a6ef9fdb-fef0-489d-87f1-5424828ab0c5",
"sales_organization_code": "sample string 5",
"sales_organization": {
"id": "941b15ae-2434-450a-ac53-a9e7aadfe846",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "6ee324aa-6040-40ef-afad-07fdb6552740",
"db_currency_id": "6a9e4613-bad4-4ef1-9fa3-b0970af7af0f",
"db_language_id": "5be5b7b8-cff5-4cc2-b4c0-7d513d776aeb",
"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-03-23T02:44:08.5904485+00:00"
},
"modified_dateutc": "2025-03-23T02:44:08.5904485+00:00"
},
"marketing_segment_id": "9db5007b-dbf4-4115-9560-7be1b095c3b2",
"marketing_segment_code": "sample string 11",
"sales_organization_id": "fcbb607f-83bf-424f-8712-02803d0e505a",
"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": "d1166d83-737d-422b-99ee-bc7e8f3c70df",
"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": "ffe03324-e507-4c2b-939b-f55d81295afb",
"db_country_code": "sample string 28",
"feelist_id": "d3a1c1df-0037-4ef7-8c8d-2fe1c2e30645",
"feelist_reference_back_office": "sample string 30",
"feelist": {
"id": "43500ac0-653d-4447-9552-051c816f36b6",
"name": "sample string 2",
"description": "sample string 3",
"is_default": true,
"default_price": 1.0,
"sales_organization_id": "5c2f208d-42c4-4f91-b6ab-dc5bf084e572",
"sales_organization_code": "sample string 6",
"reference_back_office": "sample string 7",
"modified_dateutc": "2025-03-23T02:44:08.5904485+00:00",
"db_currency_id": "5219bacb-3e76-45aa-8156-e0ad4c52fb91",
"db_currency_code": "sample string 10"
},
"company_type_id": "c61f9aff-6907-4c7d-87aa-2098fc7a9a4e",
"company_type_name": "sample string 32",
"company_type": {
"id": "8dc0c202-f7ac-44cc-8cc1-b8e89bfb2440",
"name": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "31fcb470-91a7-4cd8-9898-bacad1f184a4",
"sales_organization_code": "sample string 5"
},
"db_language_id": "70c21f81-3b7a-4cff-b6be-d78f950a80ab",
"db_language_code": "sample string 34",
"code": "sample string 35",
"article_price_label_id": "6618dba9-f9b5-4754-a868-253ff6b2c840",
"article_price_label_code": "sample string 37",
"db_payment_method_id": "222ed9fe-dcf5-43e8-b5ff-a25f029d0dc4",
"db_payment_method_reference_back_office": "sample string 39",
"db_payment_methods": {
"id": "7b8ec752-b375-431d-ba84-a068f190e128",
"name": "sample string 2",
"description": "sample string 3",
"reference_back_office": "sample string 4",
"activated": true,
"modified_dateutc": "2025-03-23T02:44:08.5904485+00:00"
},
"company_sector_id": "6da04255-941e-4e30-a6ce-0bc9fcebc949",
"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": "b0b4b009-9295-477c-8bc2-77fd3311c3fe",
"service_manager_user_code": "sample string 52",
"finance_manager_user_id": "1f5c9758-be0a-45bd-b014-9047e4199310",
"finance_manager_user_code": "sample string 54",
"account_manager_user_id": "9edce523-7df5-4e59-b585-452e0cf0ed3d",
"account_manager_user_code": "sample string 56",
"company_status_id": "e97e61e0-06d4-46e2-b37d-b046479b84d9",
"invoice_email_to": "sample string 58",
"modified_dateutc": "2025-03-23T02:44:08.5904485+00:00",
"id2": 60
},
"db_language_id": "a9dce9c3-2231-414b-8cae-9d6c25ce76b0",
"db_language_code": "sample string 7",
"db_title_id": "536626b6-c42f-4c3f-9cb5-f03577d86ecd",
"archived": true,
"functions": "sample string 10",
"e_login": "sample string 11",
"e_password": "sample string 12",
"notes": "sample string 13",
"birthdate": "2025-03-23T02:44:08.5904485+00:00",
"create_date": "2025-03-23T02:44:08.5904485+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-03-23T02:44:08.5904485+00:00"
},
"modified_dateutc": "2025-03-23T02:44:08.5904485+00:00",
"id2": 22
}