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": "c13d0ab9-4cef-4c9c-ba43-d4367bfcbfce",
"_parent_id": "6220cba4-c72f-40d3-9ac3-17d35eb0785d",
"_parent_reference_back_office": "sample string 3",
"project_status_id": "864e0d84-656b-4503-86ff-b2f5297d104f",
"company_id": "d786e4e2-be75-42fd-94ed-32e692fd4630",
"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": "63eb1287-5cef-4bd9-bff7-ec46a42a779a",
"db_country_code": "sample string 17",
"street2": "sample string 18",
"latitude_decimal": 1.0,
"longitude_decimal": 1.0,
"contact_id": "d0b217ee-9c99-42d4-bf50-e799c1b4a290",
"contact_reference_back_office": "sample string 20",
"contact": {
"id": "c9169516-33b5-4d8e-939f-94ad758cf841",
"firstname": "sample string 2",
"lastname": "sample string 3",
"company_id": "59f0fde9-f235-4a30-a5f5-e0db662c571b",
"company_code": "sample string 5",
"company": {
"id": "a0d9a778-c48b-4f87-a197-31ee145e8c5d",
"is_client": true,
"is_supplier": true,
"archived": true,
"name": "sample string 5",
"notes": "sample string 6",
"create_date": "2025-01-02T06:50:48.6340785+00:00",
"sales_territory_id": "68d93051-3f3f-4723-8d49-a545a51c295a",
"sales_territory_code": "sample string 9",
"sales_territory": {
"id": "a2821287-8c5c-4053-b561-f6836a233c0a",
"code": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "fc063832-ce43-427c-9b63-7e225abc4580",
"sales_organization_code": "sample string 5",
"sales_organization": {
"id": "caa12dc2-1358-4537-8cf7-a2690e334662",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "f4e9fc32-138d-4cd2-b361-29d7f997cb63",
"db_currency_id": "b30a2fea-91ea-4270-9eab-6c0fe4bc2bdb",
"db_language_id": "5e999f5b-fd58-493a-a703-efc157f1716d",
"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-01-02T06:50:48.6340785+00:00"
},
"modified_dateutc": "2025-01-02T06:50:48.6340785+00:00"
},
"marketing_segment_id": "94f296ee-c491-4c3f-accc-4b3a6ca63179",
"marketing_segment_code": "sample string 11",
"sales_organization_id": "e4d9f3b1-728e-4f09-a54e-33e2c7389eda",
"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": "0088f2c6-d436-4f16-8d56-4d2c985cd387",
"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": "86764a48-9c2b-42a3-9ca6-2e12f20d5636",
"db_country_code": "sample string 28",
"feelist_id": "f774fd5b-9054-4836-92c5-31b5e76b08ab",
"feelist_reference_back_office": "sample string 30",
"feelist": {
"id": "d7d1c6d8-451e-4d4e-8a14-8ba20d2cf2f4",
"name": "sample string 2",
"description": "sample string 3",
"is_default": true,
"default_price": 1.0,
"sales_organization_id": "05fc1b63-9d6c-4d03-be93-61252690630e",
"sales_organization_code": "sample string 6",
"reference_back_office": "sample string 7",
"modified_dateutc": "2025-01-02T06:50:48.6340785+00:00",
"db_currency_id": "04ad1700-0029-43f3-a810-8a6ca942990f",
"db_currency_code": "sample string 10"
},
"company_type_id": "deb119a6-718c-478e-b447-8316d1d983c8",
"company_type_name": "sample string 32",
"company_type": {
"id": "be86f91d-4b42-4ae8-873b-cb3a46a4950c",
"name": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "4242f305-017b-4032-9383-734c6b5509bc",
"sales_organization_code": "sample string 5"
},
"db_language_id": "f2dd9aa0-6ed3-408f-8ed3-14ad1a36f69e",
"db_language_code": "sample string 34",
"code": "sample string 35",
"article_price_label_id": "441e786f-d8fa-4c4a-b629-612870a8fa72",
"article_price_label_code": "sample string 37",
"db_payment_method_id": "3b2a2a46-630c-49d2-a6bb-74efca62b996",
"db_payment_method_reference_back_office": "sample string 39",
"db_payment_methods": {
"id": "7513662a-8042-4e21-b306-b5e8af4da347",
"name": "sample string 2",
"description": "sample string 3",
"reference_back_office": "sample string 4",
"activated": true,
"modified_dateutc": "2025-01-02T06:50:48.6340785+00:00"
},
"company_sector_id": "aca841d5-195a-4366-963b-2ad1e88ff643",
"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": "03990abd-d5d1-4068-a336-b78730152501",
"service_manager_user_code": "sample string 52",
"finance_manager_user_id": "83b79652-2c99-46a8-819c-06856f769cf4",
"finance_manager_user_code": "sample string 54",
"account_manager_user_id": "b35b7cb1-f805-4118-ab2c-fa00bfb81df2",
"account_manager_user_code": "sample string 56",
"company_status_id": "9359a1ec-28fe-44ed-b7a3-6fb94900b8ab",
"invoice_email_to": "sample string 58",
"modified_dateutc": "2025-01-02T06:50:48.6340785+00:00",
"id2": 60
},
"db_language_id": "55b19be8-86a5-4146-9d62-47829b6825a9",
"db_language_code": "sample string 7",
"db_title_id": "f5f3d11d-2e51-4aee-ac22-26428c1b1218",
"archived": true,
"functions": "sample string 10",
"e_login": "sample string 11",
"e_password": "sample string 12",
"notes": "sample string 13",
"birthdate": "2025-01-02T06:50:48.6340785+00:00",
"create_date": "2025-01-02T06:50:48.6340785+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-01-02T06:50:48.6340785+00:00"
},
"modified_dateutc": "2025-01-02T06:50:48.6340785+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": "e81adc78-0ecd-49c0-b466-46c9e96d8449",
"_parent_id": "dd2db6df-41be-4743-a010-985207ac3348",
"_parent_reference_back_office": "sample string 3",
"project_status_id": "9b906256-879c-4f8a-9d1f-15ba756f3018",
"company_id": "42829585-16b5-42e1-9f0c-6d30ec306ec1",
"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": "2aba5936-7618-479e-b908-0626d3f414f4",
"db_country_code": "sample string 17",
"street2": "sample string 18",
"latitude_decimal": 1.0,
"longitude_decimal": 1.0,
"contact_id": "3f48ef43-a826-4b43-bc96-445797dca629",
"contact_reference_back_office": "sample string 20",
"contact": {
"id": "29527001-9104-40e7-90f2-f027f1bd5392",
"firstname": "sample string 2",
"lastname": "sample string 3",
"company_id": "b3ffd3c5-5c9c-4512-932b-6b80a6c402a8",
"company_code": "sample string 5",
"company": {
"id": "c79b6f72-a70f-4494-8f06-bf2cdb25d436",
"is_client": true,
"is_supplier": true,
"archived": true,
"name": "sample string 5",
"notes": "sample string 6",
"create_date": "2025-01-02T06:50:48.6340785+00:00",
"sales_territory_id": "45e8488e-95e4-4004-90e4-106b485bbe7c",
"sales_territory_code": "sample string 9",
"sales_territory": {
"id": "23cadc9c-c3c9-4e10-b7bf-10e2e58d7a18",
"code": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "f92a956c-4f24-4bce-bbab-3251c332b8ac",
"sales_organization_code": "sample string 5",
"sales_organization": {
"id": "6f0dbf5e-a028-47e9-a427-0ac3c48c641b",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "31186348-d55c-4e21-8a06-76717e83ac50",
"db_currency_id": "28d00b38-b548-485d-aa0a-949bb3a1cedf",
"db_language_id": "ce5201b7-26a1-4b52-b950-5335a83843be",
"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-01-02T06:50:48.6340785+00:00"
},
"modified_dateutc": "2025-01-02T06:50:48.6340785+00:00"
},
"marketing_segment_id": "8af1430d-532e-4814-86fb-51391f9eda20",
"marketing_segment_code": "sample string 11",
"sales_organization_id": "d86412d3-698e-4144-90eb-02cde6535577",
"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": "de39d960-a084-4c8a-93cd-bd77a5c061ea",
"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": "1420d13d-52df-4027-bf64-044466ab7266",
"db_country_code": "sample string 28",
"feelist_id": "e74b94d8-3881-4bcc-b7b1-ee22ddaea7f2",
"feelist_reference_back_office": "sample string 30",
"feelist": {
"id": "c6caeb0b-a382-4121-a24a-0bd621033de0",
"name": "sample string 2",
"description": "sample string 3",
"is_default": true,
"default_price": 1.0,
"sales_organization_id": "b06f32ef-0899-4b28-8902-3d2659491ee8",
"sales_organization_code": "sample string 6",
"reference_back_office": "sample string 7",
"modified_dateutc": "2025-01-02T06:50:48.6340785+00:00",
"db_currency_id": "d3696a09-2098-4527-962a-bb64144eec8e",
"db_currency_code": "sample string 10"
},
"company_type_id": "b8d786c4-988f-4f9b-a566-7beb1b392778",
"company_type_name": "sample string 32",
"company_type": {
"id": "7695076b-1081-4a49-a5f8-21d2a5332b48",
"name": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "bde81072-cdc6-484e-8b16-8137be71b6fa",
"sales_organization_code": "sample string 5"
},
"db_language_id": "4d528987-0d7b-440e-aefb-3b23aa2e2112",
"db_language_code": "sample string 34",
"code": "sample string 35",
"article_price_label_id": "54310d78-7a35-4255-baf2-6fcbbcf5da5c",
"article_price_label_code": "sample string 37",
"db_payment_method_id": "37e89ae1-78d6-4cd4-82dc-de4027e7e6d1",
"db_payment_method_reference_back_office": "sample string 39",
"db_payment_methods": {
"id": "9740fcc8-ffb7-456b-bf8e-85c09dacd184",
"name": "sample string 2",
"description": "sample string 3",
"reference_back_office": "sample string 4",
"activated": true,
"modified_dateutc": "2025-01-02T06:50:48.6340785+00:00"
},
"company_sector_id": "fb424253-3d11-4e10-8d90-573345825637",
"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": "43ddaac4-8e4f-48c4-8271-876863c9c16a",
"service_manager_user_code": "sample string 52",
"finance_manager_user_id": "ffe89894-f7b9-43d3-b42d-bffc2aee5342",
"finance_manager_user_code": "sample string 54",
"account_manager_user_id": "35c9ee51-977c-448b-8250-d4ee6906bf19",
"account_manager_user_code": "sample string 56",
"company_status_id": "02b3e569-826e-48cc-ad27-5a181a3c3954",
"invoice_email_to": "sample string 58",
"modified_dateutc": "2025-01-02T06:50:48.6340785+00:00",
"id2": 60
},
"db_language_id": "f790e4ce-5f78-4b76-a51b-8a69e0c9684c",
"db_language_code": "sample string 7",
"db_title_id": "10e0d509-a743-43de-bff9-b15e81cbfc14",
"archived": true,
"functions": "sample string 10",
"e_login": "sample string 11",
"e_password": "sample string 12",
"notes": "sample string 13",
"birthdate": "2025-01-02T06:50:48.6340785+00:00",
"create_date": "2025-01-02T06:50:48.6340785+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-01-02T06:50:48.6340785+00:00"
},
"modified_dateutc": "2025-01-02T06:50:48.6340785+00:00",
"id2": 22
}