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": "73aaa2f6-aaaa-4fa4-8233-af10922817af",
"_parent_id": "62db283c-eba1-47a0-a204-da0b7863c7fa",
"_parent_reference_back_office": "sample string 3",
"project_status_id": "318dbe68-9083-4667-b78f-1df7c3dff9d3",
"company_id": "591944ac-c76f-4939-9bba-6fd48fa6821f",
"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": "041bcaa3-1725-4f3a-9fd6-c4bdec8d9717",
"db_country_code": "sample string 17",
"street2": "sample string 18",
"latitude_decimal": 1.0,
"longitude_decimal": 1.0,
"contact_id": "1c3b5fbd-0a2f-4e96-8e6d-21e80a1c7866",
"contact_reference_back_office": "sample string 20",
"contact": {
"id": "2451fadd-8f84-4150-b8e4-80bde9fcaa8f",
"firstname": "sample string 2",
"lastname": "sample string 3",
"company_id": "461d9b14-5f93-4fbd-9a95-4019adc547f2",
"company_code": "sample string 5",
"company": {
"id": "484e1447-051a-4c6b-a880-84cf81b96cee",
"is_client": true,
"is_supplier": true,
"archived": true,
"name": "sample string 5",
"notes": "sample string 6",
"create_date": "2024-04-20T05:05:54.0111513+00:00",
"sales_territory_id": "ec4cc5b4-d969-4a2b-b73d-78f0c4a00e05",
"sales_territory_code": "sample string 9",
"sales_territory": {
"id": "c36260b9-0f71-4fdb-966d-a58ee938bf3b",
"code": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "79d24752-0ab1-48a1-bbf0-eae33a8e55e1",
"sales_organization_code": "sample string 5",
"sales_organization": {
"id": "6c9cd5d1-505d-42d4-be5c-6fb7014726b3",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "bb4d1c68-cd4c-417c-ba30-d7db6e53dbc9",
"db_currency_id": "1a92c5b0-ddf6-47a1-9a4c-d5fb30e28543",
"db_language_id": "3459e200-d784-4f5f-b208-8ad69d70ee09",
"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": "2024-04-20T05:05:54.0111513+00:00"
},
"modified_dateutc": "2024-04-20T05:05:54.0111513+00:00"
},
"marketing_segment_id": "3f75ca42-12d4-4c3f-ae94-7ce7cf86c877",
"marketing_segment_code": "sample string 11",
"sales_organization_id": "b3dd80a1-8f9d-4b15-9e72-533a06c6ab4d",
"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": "ee246f48-5e93-4a55-aae4-9a58347d8cc6",
"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": "ca7216aa-cec6-4659-97b9-02c25ab11b3a",
"db_country_code": "sample string 28",
"feelist_id": "e8d77125-20e9-4d41-af70-30035f3e434e",
"feelist_reference_back_office": "sample string 30",
"feelist": {
"id": "1f4a6ac7-67b2-45bd-9ec6-5882b00d1b31",
"name": "sample string 2",
"description": "sample string 3",
"is_default": true,
"default_price": 1.0,
"sales_organization_id": "8e078b44-455e-4aaa-b5d1-09dc4d336b56",
"sales_organization_code": "sample string 6",
"reference_back_office": "sample string 7",
"modified_dateutc": "2024-04-20T05:05:54.0111513+00:00",
"db_currency_id": "38c8b1dc-15a4-490d-89f9-d678b2985104",
"db_currency_code": "sample string 10"
},
"company_type_id": "23c98135-27a1-4452-934c-5d79a21e2fc9",
"company_type_name": "sample string 32",
"company_type": {
"id": "f19d8208-0d70-415a-907d-2b04c2902b79",
"name": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "005206b4-eaf1-41d7-b84a-16417d512df2",
"sales_organization_code": "sample string 5"
},
"db_language_id": "9edba0b8-2467-4aa4-86fa-7e6b649118c1",
"db_language_code": "sample string 34",
"code": "sample string 35",
"article_price_label_id": "f4b82fab-33a1-40d6-a74f-ce39c0df0038",
"article_price_label_code": "sample string 37",
"db_payment_method_id": "a0af53e1-0afa-448d-bfcd-fa10fa9dd009",
"db_payment_method_reference_back_office": "sample string 39",
"db_payment_methods": {
"id": "a30d4954-965b-4008-ae1e-7eeca82a5c1e",
"name": "sample string 2",
"description": "sample string 3",
"reference_back_office": "sample string 4",
"activated": true,
"modified_dateutc": "2024-04-20T05:05:54.0111513+00:00"
},
"company_sector_id": "da60592f-1169-4790-b23d-55b81953543b",
"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": "6bfe74aa-08ac-4824-b7f1-4496f17fc403",
"service_manager_user_code": "sample string 52",
"finance_manager_user_id": "58e54dff-5c67-4412-9d1e-c0879f930605",
"finance_manager_user_code": "sample string 54",
"account_manager_user_id": "c0a7332f-88e7-42ca-922c-636f7e369dd9",
"account_manager_user_code": "sample string 56",
"company_status_id": "16fd25b2-5411-4172-8b2b-fcc52bb3ef09",
"invoice_email_to": "sample string 58",
"modified_dateutc": "2024-04-20T05:05:54.0111513+00:00",
"id2": 60
},
"db_language_id": "c29d34ab-5760-4266-9b82-9d990f4090e9",
"db_language_code": "sample string 7",
"db_title_id": "1288daf7-1685-4e7f-b542-921c84a54ffd",
"archived": true,
"functions": "sample string 10",
"e_login": "sample string 11",
"e_password": "sample string 12",
"notes": "sample string 13",
"birthdate": "2024-04-20T05:05:54.0111513+00:00",
"create_date": "2024-04-20T05:05:54.0111513+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": "2024-04-20T05:05:54.0111513+00:00"
},
"modified_dateutc": "2024-04-20T05:05:54.0111513+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": "2d43a8c3-97cb-42e8-bf48-8625a32a5006",
"_parent_id": "e112c283-6fc2-4050-93e6-4b7ba3a151ec",
"_parent_reference_back_office": "sample string 3",
"project_status_id": "8652f302-10f5-4030-902a-98e27f7e1501",
"company_id": "fe5f13e0-3536-420a-abff-599f821d3632",
"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": "c02f0cc1-0b3d-43bd-a17c-b2dc936ef903",
"db_country_code": "sample string 17",
"street2": "sample string 18",
"latitude_decimal": 1.0,
"longitude_decimal": 1.0,
"contact_id": "742487d0-1335-4a33-8ba4-e6c99651b862",
"contact_reference_back_office": "sample string 20",
"contact": {
"id": "230d90a7-73f0-42a9-b53a-01f8047eb002",
"firstname": "sample string 2",
"lastname": "sample string 3",
"company_id": "35b2c612-1034-4d76-a931-44c28f6cedb4",
"company_code": "sample string 5",
"company": {
"id": "b011a064-0e9c-4e87-9850-e2d8189be41d",
"is_client": true,
"is_supplier": true,
"archived": true,
"name": "sample string 5",
"notes": "sample string 6",
"create_date": "2024-04-20T05:05:54.0111513+00:00",
"sales_territory_id": "08b15e7d-e9e6-400d-a139-cc8c50a0d801",
"sales_territory_code": "sample string 9",
"sales_territory": {
"id": "50e353e1-6c2f-4da8-8b7c-42aefac5a53c",
"code": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "d247ce93-9d00-4538-8938-b288beb3a66c",
"sales_organization_code": "sample string 5",
"sales_organization": {
"id": "6d267261-59ca-4d53-9d77-3e5b9c1c00f5",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "df43ea9a-8d5b-463b-a931-39479d2b6bab",
"db_currency_id": "2993d71d-d738-4cb6-839f-ac25f66aaf63",
"db_language_id": "5825bb5d-38d4-4ef3-9493-8a0f885c0c89",
"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": "2024-04-20T05:05:54.0111513+00:00"
},
"modified_dateutc": "2024-04-20T05:05:54.0111513+00:00"
},
"marketing_segment_id": "6016bd97-0606-42e0-9cb7-9092080c8eaf",
"marketing_segment_code": "sample string 11",
"sales_organization_id": "12d5ce91-12f6-4d08-ac01-6be5b211f375",
"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": "fb251b47-daa9-4be9-ba32-c6ae8796c616",
"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": "5e9b9443-e70f-43f6-b524-2069dd5b29ac",
"db_country_code": "sample string 28",
"feelist_id": "c8009b43-fba0-4547-852b-2479b168ae4b",
"feelist_reference_back_office": "sample string 30",
"feelist": {
"id": "6409f994-28db-405c-a2da-487796198b69",
"name": "sample string 2",
"description": "sample string 3",
"is_default": true,
"default_price": 1.0,
"sales_organization_id": "b29fed02-cf28-4594-b3aa-9b60832909be",
"sales_organization_code": "sample string 6",
"reference_back_office": "sample string 7",
"modified_dateutc": "2024-04-20T05:05:54.0111513+00:00",
"db_currency_id": "b0ec9719-1465-4280-b1fd-2033c0bb27ef",
"db_currency_code": "sample string 10"
},
"company_type_id": "3fcb7b21-ca3e-411c-b982-f722213a20cc",
"company_type_name": "sample string 32",
"company_type": {
"id": "96be8285-a6f0-4178-9ff9-23b8ed49bdcb",
"name": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "29bbfca1-27e5-4d55-b698-a5e4b74ffa8b",
"sales_organization_code": "sample string 5"
},
"db_language_id": "a0cd1497-6356-480a-81bd-111823b97cf8",
"db_language_code": "sample string 34",
"code": "sample string 35",
"article_price_label_id": "ac7250de-157a-45e1-84e3-8da1e97ca8d2",
"article_price_label_code": "sample string 37",
"db_payment_method_id": "dfeb9ac5-47fd-45b7-bac0-c63ef87b037e",
"db_payment_method_reference_back_office": "sample string 39",
"db_payment_methods": {
"id": "3dff14c9-d27c-4e49-b7b6-b3d3097d33ce",
"name": "sample string 2",
"description": "sample string 3",
"reference_back_office": "sample string 4",
"activated": true,
"modified_dateutc": "2024-04-20T05:05:54.0111513+00:00"
},
"company_sector_id": "21bb24c4-7352-4481-b0fc-9aeab65ff329",
"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": "8dd01715-85e5-4ad3-9ce5-356bc8fe8b0a",
"service_manager_user_code": "sample string 52",
"finance_manager_user_id": "52e4fca3-2d4a-46b6-bd80-11a21f115746",
"finance_manager_user_code": "sample string 54",
"account_manager_user_id": "b7c51b99-4f34-4805-9dc3-ad91ce211fa7",
"account_manager_user_code": "sample string 56",
"company_status_id": "7a1cc653-fd2b-4c52-a614-ab22d9d52d07",
"invoice_email_to": "sample string 58",
"modified_dateutc": "2024-04-20T05:05:54.0111513+00:00",
"id2": 60
},
"db_language_id": "1c393b61-a649-4aa9-b7cc-2e91dce845fd",
"db_language_code": "sample string 7",
"db_title_id": "b426f9ad-88e0-4833-8a8d-f1fc66ed0034",
"archived": true,
"functions": "sample string 10",
"e_login": "sample string 11",
"e_password": "sample string 12",
"notes": "sample string 13",
"birthdate": "2024-04-20T05:05:54.0111513+00:00",
"create_date": "2024-04-20T05:05:54.0111513+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": "2024-04-20T05:05:54.0111513+00:00"
},
"modified_dateutc": "2024-04-20T05:05:54.0111513+00:00",
"id2": 22
}