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": "eac66921-8d7a-487a-89ad-717f85b9afe9",
"_parent_id": "9f6a8fe9-49f8-4caa-869a-53686cc91d20",
"_parent_reference_back_office": "sample string 3",
"project_status_id": "c7f7acab-c43d-45f0-93b2-b37cf62e3fbf",
"company_id": "77366a96-265c-493d-a4de-70e14a44cf69",
"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": "3a178a41-dcf1-49ac-b0a1-a8661f349001",
"db_country_code": "sample string 17",
"street2": "sample string 18",
"latitude_decimal": 1.0,
"longitude_decimal": 1.0,
"contact_id": "59dbeac4-cd1a-4ed1-9810-40f32b33f81d",
"contact_reference_back_office": "sample string 20",
"contact": {
"id": "8f494fa0-b62c-4d42-a89a-496191705894",
"firstname": "sample string 2",
"lastname": "sample string 3",
"company_id": "21971a14-f1eb-459e-a2e6-2946823699b4",
"company_code": "sample string 5",
"company": {
"id": "3bb957e9-08f2-425f-8d26-734d609c849c",
"is_client": true,
"is_supplier": true,
"archived": true,
"name": "sample string 5",
"notes": "sample string 6",
"create_date": "2025-02-05T06:53:14.2903468+00:00",
"sales_territory_id": "8cd5c7c6-ff55-42ad-898e-6cd9e3700789",
"sales_territory_code": "sample string 9",
"sales_territory": {
"id": "b8d971a9-1d2a-484e-ab75-a1cc2c5521f9",
"code": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "5f0e5bc6-ae6a-4dee-a184-1f1eaec2562e",
"sales_organization_code": "sample string 5",
"sales_organization": {
"id": "5b0776fa-ef24-4396-ae92-0ee0b0f23b58",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "4e4874f6-31d6-4a78-afb3-7c88c9b65103",
"db_currency_id": "3fed3283-c780-48c2-b99a-9f92209e5e99",
"db_language_id": "2a2a7b63-758f-49c9-9894-fa9c2f1dd38b",
"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-02-05T06:53:14.2903468+00:00"
},
"modified_dateutc": "2025-02-05T06:53:14.2903468+00:00"
},
"marketing_segment_id": "69913776-34ca-48fa-ace2-609cead88a1a",
"marketing_segment_code": "sample string 11",
"sales_organization_id": "26e4c73a-9a37-4a33-9899-fd751a25db6a",
"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": "4c73ea55-111b-49b8-bfdb-010c26860351",
"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": "5b8ae317-9e22-4b45-941b-25cd97560cc9",
"db_country_code": "sample string 28",
"feelist_id": "52ac945f-4cb0-43d6-b9ed-20b2c94685c9",
"feelist_reference_back_office": "sample string 30",
"feelist": {
"id": "7d82e14a-0083-4560-bbb5-d65cd48afdee",
"name": "sample string 2",
"description": "sample string 3",
"is_default": true,
"default_price": 1.0,
"sales_organization_id": "cd11a39b-34cd-42e7-8aba-c56cf3512899",
"sales_organization_code": "sample string 6",
"reference_back_office": "sample string 7",
"modified_dateutc": "2025-02-05T06:53:14.2903468+00:00",
"db_currency_id": "5925361a-0afe-4da0-a086-96179b5ba21f",
"db_currency_code": "sample string 10"
},
"company_type_id": "52abb5fe-59cb-4227-8184-c90ae9eea45f",
"company_type_name": "sample string 32",
"company_type": {
"id": "4e9113d5-51c6-445f-b589-b6b43d659fb4",
"name": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "3f7a8b35-5463-4c64-b790-fbdc22bdd231",
"sales_organization_code": "sample string 5"
},
"db_language_id": "8bc8f28d-fbb1-40da-bc54-d1a9847ec9b1",
"db_language_code": "sample string 34",
"code": "sample string 35",
"article_price_label_id": "b96b77bd-f9d1-4664-9d74-bedc2535af06",
"article_price_label_code": "sample string 37",
"db_payment_method_id": "bc8cabe2-99b9-4ada-8579-e24553fa4e13",
"db_payment_method_reference_back_office": "sample string 39",
"db_payment_methods": {
"id": "563aba49-bd5b-46e4-b45e-11b2320c452a",
"name": "sample string 2",
"description": "sample string 3",
"reference_back_office": "sample string 4",
"activated": true,
"modified_dateutc": "2025-02-05T06:53:14.2903468+00:00"
},
"company_sector_id": "386722a7-30de-462b-897c-e308f17ce3c7",
"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": "eb6f6b57-154b-4628-bd7a-e350e7114e50",
"service_manager_user_code": "sample string 52",
"finance_manager_user_id": "f23467e1-fade-4011-b871-b1b0dae6556b",
"finance_manager_user_code": "sample string 54",
"account_manager_user_id": "47e73da8-9b39-460d-921a-e9f92b77d42d",
"account_manager_user_code": "sample string 56",
"company_status_id": "635837df-18ff-4397-82cc-44fdc80305ad",
"invoice_email_to": "sample string 58",
"modified_dateutc": "2025-02-05T06:53:14.2903468+00:00",
"id2": 60
},
"db_language_id": "b6b60e98-52d8-4b8d-a128-cd795ada1608",
"db_language_code": "sample string 7",
"db_title_id": "07467314-897b-4839-9be4-8b1d4643699e",
"archived": true,
"functions": "sample string 10",
"e_login": "sample string 11",
"e_password": "sample string 12",
"notes": "sample string 13",
"birthdate": "2025-02-05T06:53:14.2903468+00:00",
"create_date": "2025-02-05T06:53:14.2903468+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-02-05T06:53:14.2903468+00:00"
},
"modified_dateutc": "2025-02-05T06:53:14.2903468+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": "7d0c1252-9513-4d7a-b550-ae08b85c14bb",
"_parent_id": "2eeb3488-6cb3-4dc7-ad3e-a80f1675c1df",
"_parent_reference_back_office": "sample string 3",
"project_status_id": "0a630157-7487-44e5-9a3f-dffd9f1a6847",
"company_id": "82dc44aa-f9c9-415d-b011-90c68bd164f0",
"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": "c8193cb7-8b13-470b-ad89-741ebf609daa",
"db_country_code": "sample string 17",
"street2": "sample string 18",
"latitude_decimal": 1.0,
"longitude_decimal": 1.0,
"contact_id": "4b1c6821-0c31-4ca6-a45c-29569d79b936",
"contact_reference_back_office": "sample string 20",
"contact": {
"id": "9d7721e3-1543-482a-af19-c46d6e307e0b",
"firstname": "sample string 2",
"lastname": "sample string 3",
"company_id": "c61edf77-375b-43ae-bfb5-8655c324820b",
"company_code": "sample string 5",
"company": {
"id": "1f6d0c99-6dbf-4f4d-908c-f99200ee340b",
"is_client": true,
"is_supplier": true,
"archived": true,
"name": "sample string 5",
"notes": "sample string 6",
"create_date": "2025-02-05T06:53:14.2903468+00:00",
"sales_territory_id": "80950e58-f9c6-4144-bd8a-7992e9a8260c",
"sales_territory_code": "sample string 9",
"sales_territory": {
"id": "f3b7d6ad-bbb6-48ec-bce6-9a57d28aba98",
"code": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "f60a89fc-41b3-42ea-ac68-27ed202b0c96",
"sales_organization_code": "sample string 5",
"sales_organization": {
"id": "576afddd-0b2c-41aa-a770-47fc410458d4",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "4ec7ae04-d900-4e21-9f02-58e65cbd1f80",
"db_currency_id": "ec92886b-f08a-4e4c-b4d3-88720bd286ba",
"db_language_id": "e13da530-87b0-45cb-b694-fa703c505fba",
"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-02-05T06:53:14.2903468+00:00"
},
"modified_dateutc": "2025-02-05T06:53:14.2903468+00:00"
},
"marketing_segment_id": "de06c17f-8a7e-4a0f-a848-bbdd7926fa9e",
"marketing_segment_code": "sample string 11",
"sales_organization_id": "086d83ef-7e89-4b94-8adf-eb644e747921",
"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": "f5b241fd-2d5d-4ea3-8b44-fef9a7f5a252",
"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": "19eec607-762e-48e9-8608-cb06302cedcd",
"db_country_code": "sample string 28",
"feelist_id": "88b07a50-f1f7-49b2-881f-7a62ebeced1e",
"feelist_reference_back_office": "sample string 30",
"feelist": {
"id": "effff929-0d34-4ab4-9108-d3494a1589fb",
"name": "sample string 2",
"description": "sample string 3",
"is_default": true,
"default_price": 1.0,
"sales_organization_id": "9fa0773a-cbb3-4fa2-9c7f-b6cc2ceb46d4",
"sales_organization_code": "sample string 6",
"reference_back_office": "sample string 7",
"modified_dateutc": "2025-02-05T06:53:14.2903468+00:00",
"db_currency_id": "ff9d3011-fe30-4861-8706-e45d3794808e",
"db_currency_code": "sample string 10"
},
"company_type_id": "69043d01-ec14-4bb3-8e1e-eb91effb6eb3",
"company_type_name": "sample string 32",
"company_type": {
"id": "b53a00ec-970b-410f-957f-c8e29b7373ed",
"name": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "e8728cbb-874e-4323-b5de-68d7b3f4ca4c",
"sales_organization_code": "sample string 5"
},
"db_language_id": "02427816-54a8-43f0-a296-f3934dd787e4",
"db_language_code": "sample string 34",
"code": "sample string 35",
"article_price_label_id": "a108b8a9-ebd1-470f-ab03-ae5b212b3f1f",
"article_price_label_code": "sample string 37",
"db_payment_method_id": "da4a247b-5211-46a4-9418-456dcf7d90d5",
"db_payment_method_reference_back_office": "sample string 39",
"db_payment_methods": {
"id": "b96aae89-8d09-4e1b-9ab9-6e4289832462",
"name": "sample string 2",
"description": "sample string 3",
"reference_back_office": "sample string 4",
"activated": true,
"modified_dateutc": "2025-02-05T06:53:14.2903468+00:00"
},
"company_sector_id": "aec2188e-82a7-4b50-968d-ccd83564df91",
"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": "5484e990-e1f8-4465-9928-edd9c5a91d38",
"service_manager_user_code": "sample string 52",
"finance_manager_user_id": "48cf5175-e25a-4e4b-b3d4-50eb0670413e",
"finance_manager_user_code": "sample string 54",
"account_manager_user_id": "fb87f18a-c4aa-4558-b6c8-2c94c5214dbb",
"account_manager_user_code": "sample string 56",
"company_status_id": "5a76bd9d-21f6-491a-a332-0972bcf0f06f",
"invoice_email_to": "sample string 58",
"modified_dateutc": "2025-02-05T06:53:14.2903468+00:00",
"id2": 60
},
"db_language_id": "65dcace4-a1eb-4c1d-8936-fcd9ca7935eb",
"db_language_code": "sample string 7",
"db_title_id": "bcfbeaf9-e076-4381-9d32-14faa637038a",
"archived": true,
"functions": "sample string 10",
"e_login": "sample string 11",
"e_password": "sample string 12",
"notes": "sample string 13",
"birthdate": "2025-02-05T06:53:14.2903468+00:00",
"create_date": "2025-02-05T06:53:14.2903468+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-02-05T06:53:14.2903468+00:00"
},
"modified_dateutc": "2025-02-05T06:53:14.2903468+00:00",
"id2": 22
}