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": "8d41c6a9-5453-483a-83cb-5724b9290b8a",
"_parent_id": "387a04ea-b3fe-4320-8765-41fba02e2f7a",
"_parent_reference_back_office": "sample string 3",
"project_status_id": "342800c8-e5c5-4609-9fac-b3f5041b82a3",
"company_id": "1d4c52e5-1f7c-41d6-9d48-f874b4c758c2",
"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": "7d24dee1-03e8-4bed-8033-ad02d2868229",
"db_country_code": "sample string 17",
"street2": "sample string 18",
"latitude_decimal": 1.0,
"longitude_decimal": 1.0,
"contact_id": "7ac787a4-6889-4892-9271-882f892aa58c",
"contact_reference_back_office": "sample string 20",
"contact": {
"id": "aee97f55-8fa1-4b92-b9eb-d21d5589ba26",
"firstname": "sample string 2",
"lastname": "sample string 3",
"company_id": "5c13267c-41e8-4585-96a5-cd60e9e3ffe2",
"company_code": "sample string 5",
"company": {
"id": "9a34c11c-5e0b-4452-a712-6049febdef0b",
"is_client": true,
"is_supplier": true,
"archived": true,
"name": "sample string 5",
"notes": "sample string 6",
"create_date": "2025-03-07T02:25:59.9584151+00:00",
"sales_territory_id": "9057601e-6a1c-44a0-afed-846dbb957b15",
"sales_territory_code": "sample string 9",
"sales_territory": {
"id": "3cc5cf9e-9e62-4c79-9665-8d1c01b995f7",
"code": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "ff17e152-ba4e-4e8f-a2d5-7dbef8cc2d6a",
"sales_organization_code": "sample string 5",
"sales_organization": {
"id": "65836cad-ec95-49d0-8828-0b3b964fb223",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "a2a76e70-09fc-4d56-b4af-2a5ca422776f",
"db_currency_id": "8c9c4192-e234-4a9c-a5af-d35f8b876cb4",
"db_language_id": "21c30d5a-a49f-47cb-8643-93f1e483de1b",
"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-07T02:25:59.9584151+00:00"
},
"modified_dateutc": "2025-03-07T02:25:59.9584151+00:00"
},
"marketing_segment_id": "06b409f3-bc7f-4aa8-b044-cf63c28be0ea",
"marketing_segment_code": "sample string 11",
"sales_organization_id": "4b69d5ba-ee94-4224-af82-db046bb168ed",
"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": "a855c62f-fde4-4794-b69f-d0d8ffa133ae",
"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": "aa5d999d-30bc-4808-86e3-558a4fa05981",
"db_country_code": "sample string 28",
"feelist_id": "2af9329a-646a-476e-8aa2-2c73e4b8ef90",
"feelist_reference_back_office": "sample string 30",
"feelist": {
"id": "2769697e-3d01-4315-9265-d7be4156759f",
"name": "sample string 2",
"description": "sample string 3",
"is_default": true,
"default_price": 1.0,
"sales_organization_id": "edfc267f-55b4-43f9-874f-94ee6ee73cc1",
"sales_organization_code": "sample string 6",
"reference_back_office": "sample string 7",
"modified_dateutc": "2025-03-07T02:25:59.9584151+00:00",
"db_currency_id": "3219bdd9-72cd-4a41-8156-6475c9661356",
"db_currency_code": "sample string 10"
},
"company_type_id": "427b4626-2c5f-425e-be13-2ef447da680e",
"company_type_name": "sample string 32",
"company_type": {
"id": "ae512560-322a-48dd-81da-8210dbaa2546",
"name": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "99bc78d8-c7c9-4e65-ae9f-e4efd0f9e433",
"sales_organization_code": "sample string 5"
},
"db_language_id": "d0ccb8c9-da5d-43b3-84ef-24817e01b346",
"db_language_code": "sample string 34",
"code": "sample string 35",
"article_price_label_id": "b7ad56ba-4d55-48a0-8507-4b013c0b28fb",
"article_price_label_code": "sample string 37",
"db_payment_method_id": "4e02253f-f81f-4857-995d-fb40dc37413c",
"db_payment_method_reference_back_office": "sample string 39",
"db_payment_methods": {
"id": "283ccf2e-f0fd-4064-9251-fc1cc9248279",
"name": "sample string 2",
"description": "sample string 3",
"reference_back_office": "sample string 4",
"activated": true,
"modified_dateutc": "2025-03-07T02:25:59.9584151+00:00"
},
"company_sector_id": "026c65e1-701f-4713-8f42-eabd65624406",
"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": "36d806f9-8e2c-449d-9ce6-d1d39212d635",
"service_manager_user_code": "sample string 52",
"finance_manager_user_id": "79d34027-c64b-4654-88c7-9b848f549580",
"finance_manager_user_code": "sample string 54",
"account_manager_user_id": "bdd0e4cb-fb45-4e46-aa83-5846780f3f06",
"account_manager_user_code": "sample string 56",
"company_status_id": "1f084ee0-6495-4cb0-936a-8426430f4063",
"invoice_email_to": "sample string 58",
"modified_dateutc": "2025-03-07T02:25:59.9584151+00:00",
"id2": 60
},
"db_language_id": "708b8e01-4e10-49a1-958e-80e80df7a227",
"db_language_code": "sample string 7",
"db_title_id": "60b15a4e-17ee-48ac-8568-c0da2dbbc5f8",
"archived": true,
"functions": "sample string 10",
"e_login": "sample string 11",
"e_password": "sample string 12",
"notes": "sample string 13",
"birthdate": "2025-03-07T02:25:59.9584151+00:00",
"create_date": "2025-03-07T02:25:59.9584151+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-07T02:25:59.9584151+00:00"
},
"modified_dateutc": "2025-03-07T02:25:59.9584151+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": "8279761b-e784-48b2-be7c-5c6ba7797bde",
"_parent_id": "8ec75eca-11ea-4ccc-a5df-74661c9ea0f7",
"_parent_reference_back_office": "sample string 3",
"project_status_id": "9dc798f7-060c-47b9-8b42-74942f1949af",
"company_id": "fe4f6c1d-820a-4ae7-8bca-3cd32e16c176",
"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": "2d59460a-09d2-4603-9f57-db4db5016405",
"db_country_code": "sample string 17",
"street2": "sample string 18",
"latitude_decimal": 1.0,
"longitude_decimal": 1.0,
"contact_id": "18ee2aa1-6602-4837-a116-a42fc8f78b42",
"contact_reference_back_office": "sample string 20",
"contact": {
"id": "468200d8-815a-4454-a10f-5034de19e5e8",
"firstname": "sample string 2",
"lastname": "sample string 3",
"company_id": "8c902dcb-08b9-4a24-92bc-cc3103ba7a3a",
"company_code": "sample string 5",
"company": {
"id": "741e54d5-a87b-4428-a365-976bb8c28938",
"is_client": true,
"is_supplier": true,
"archived": true,
"name": "sample string 5",
"notes": "sample string 6",
"create_date": "2025-03-07T02:26:00.1146717+00:00",
"sales_territory_id": "3a3ad5a0-70f0-4698-9e95-79296ea822ae",
"sales_territory_code": "sample string 9",
"sales_territory": {
"id": "6aaa1d2b-6f6f-45c0-abce-18facd01b7e6",
"code": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "18d7f88c-e36f-4692-b5f8-f6f3bb712bbe",
"sales_organization_code": "sample string 5",
"sales_organization": {
"id": "57b0d4f8-f88f-4322-a7c8-141c87b4f769",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "a83c16b3-a0a2-498b-a283-f3236e38f609",
"db_currency_id": "a797807b-931c-4f34-b63f-751cb6ba4df2",
"db_language_id": "cb076bf7-eb7d-48ed-8f56-043f934de1f6",
"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-07T02:26:00.1146717+00:00"
},
"modified_dateutc": "2025-03-07T02:26:00.1146717+00:00"
},
"marketing_segment_id": "1d56645d-6238-4cbf-9088-d6ea0edaf51d",
"marketing_segment_code": "sample string 11",
"sales_organization_id": "5c88bd8a-833c-4e75-bfe8-fbb7eea2c94d",
"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": "c68a749f-60d0-40a6-a279-abc03d8828cb",
"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": "2cb8af13-44dc-4e93-9f12-aa8f40380023",
"db_country_code": "sample string 28",
"feelist_id": "d70d5256-d300-4e3a-bc96-c603e6acc15c",
"feelist_reference_back_office": "sample string 30",
"feelist": {
"id": "edd78019-39f8-4d83-99ea-ac2a426896ff",
"name": "sample string 2",
"description": "sample string 3",
"is_default": true,
"default_price": 1.0,
"sales_organization_id": "8ed78b37-50ea-40da-813e-7f8fda83cd54",
"sales_organization_code": "sample string 6",
"reference_back_office": "sample string 7",
"modified_dateutc": "2025-03-07T02:26:00.1146717+00:00",
"db_currency_id": "9a2b8d43-944e-4ab1-bd06-d5a3adaa309e",
"db_currency_code": "sample string 10"
},
"company_type_id": "01632a24-5a7c-4196-be05-5eeffec67d5f",
"company_type_name": "sample string 32",
"company_type": {
"id": "bdb267af-539f-42eb-8e1e-edcbd2a96b6b",
"name": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "2be8c4a0-b351-4a71-bf92-28cbc42571e7",
"sales_organization_code": "sample string 5"
},
"db_language_id": "a61ddb84-dc68-4f5a-a459-a2a95b2774d6",
"db_language_code": "sample string 34",
"code": "sample string 35",
"article_price_label_id": "ae43b9c5-c740-467b-ba98-86c6b68bf048",
"article_price_label_code": "sample string 37",
"db_payment_method_id": "3ca94cb3-2152-4f0c-a33f-87a75d1ace73",
"db_payment_method_reference_back_office": "sample string 39",
"db_payment_methods": {
"id": "9496db7a-4d06-4e98-ad41-1db315a9d0f4",
"name": "sample string 2",
"description": "sample string 3",
"reference_back_office": "sample string 4",
"activated": true,
"modified_dateutc": "2025-03-07T02:26:00.1146717+00:00"
},
"company_sector_id": "9523fce1-96a7-4832-bda5-28862cefacd1",
"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": "de509ced-793f-406f-b5fe-7d1596e674d0",
"service_manager_user_code": "sample string 52",
"finance_manager_user_id": "bfc7d0b4-da05-4a99-a3d9-e79d058ab569",
"finance_manager_user_code": "sample string 54",
"account_manager_user_id": "31db104c-5218-4a0c-8631-305a132f1dee",
"account_manager_user_code": "sample string 56",
"company_status_id": "a6df3a38-8f6f-49ba-9cb0-34f1273153aa",
"invoice_email_to": "sample string 58",
"modified_dateutc": "2025-03-07T02:26:00.1146717+00:00",
"id2": 60
},
"db_language_id": "f8df6fd4-6c40-4898-816e-bc21ff1f425d",
"db_language_code": "sample string 7",
"db_title_id": "33a286d3-d698-4632-a22c-5bc3fd1b80cc",
"archived": true,
"functions": "sample string 10",
"e_login": "sample string 11",
"e_password": "sample string 12",
"notes": "sample string 13",
"birthdate": "2025-03-07T02:26:00.1146717+00:00",
"create_date": "2025-03-07T02:26:00.1146717+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-07T02:26:00.1146717+00:00"
},
"modified_dateutc": "2025-03-07T02:26:00.1146717+00:00",
"id2": 22
}