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": "eecc4d89-3d85-460e-ade9-f36469ae8122",
"_parent_id": "d5a76dd1-f725-4084-b310-651efdb25f13",
"_parent_reference_back_office": "sample string 3",
"project_status_id": "d05ef116-bfee-481d-add4-62ab4ab84a68",
"company_id": "eeb2f74b-866d-4803-8aa3-24ee74d8507b",
"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": "cc246d30-dfe3-439b-b2b6-79dc63d021da",
"db_country_code": "sample string 17",
"street2": "sample string 18",
"latitude_decimal": 1.0,
"longitude_decimal": 1.0,
"contact_id": "37e7636e-74be-4896-a703-f07583444bb7",
"contact_reference_back_office": "sample string 20",
"contact": {
"id": "c8072d44-812b-4d49-b177-24bc0e585d30",
"firstname": "sample string 2",
"lastname": "sample string 3",
"company_id": "567d40ca-f64f-4b0e-b098-c5c70ad7ef4c",
"company_code": "sample string 5",
"company": {
"id": "0da8ace2-c099-45db-8f9f-d85a907e77fa",
"is_client": true,
"is_supplier": true,
"archived": true,
"name": "sample string 5",
"notes": "sample string 6",
"create_date": "2026-08-14T04:29:18.3026205+00:00",
"sales_territory_id": "bf45c151-d22a-438f-b63b-94e8f3a20da6",
"sales_territory_code": "sample string 9",
"sales_territory": {
"id": "f0111cf5-f60a-4d5e-9920-156de74d2792",
"code": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "740c0098-005e-4f7f-aa76-412e1b216189",
"sales_organization_code": "sample string 5",
"sales_organization": {
"id": "f4510b08-752b-4c03-8385-ca6168b84797",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "e549c0d6-08f3-4b63-8288-ebe20518fb6b",
"db_currency_id": "9b2e166a-e10a-4ac9-b509-55b0d385676e",
"db_language_id": "f840c2f6-eb1c-48f1-a48b-e01286c5f403",
"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": "2026-08-14T04:29:18.3026205+00:00"
},
"modified_dateutc": "2026-08-14T04:29:18.3026205+00:00"
},
"marketing_segment_id": "0adfe7da-4fb3-499f-8464-2e1341ff14a3",
"marketing_segment_code": "sample string 11",
"sales_organization_id": "354e7e4b-d84d-4020-9514-c67f6bc218f4",
"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": "4df52394-4047-4c6e-a913-6efedbe7ddbf",
"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": "d7277d95-00f8-42ae-a0ba-31a831abf443",
"db_country_code": "sample string 28",
"feelist_id": "022248b0-54a3-4e50-836c-444fb96f84a4",
"feelist_reference_back_office": "sample string 30",
"feelist": {
"id": "8f01daa0-6a3f-4da4-90d7-444c2ab41211",
"name": "sample string 2",
"description": "sample string 3",
"is_default": true,
"default_price": 1.0,
"sales_organization_id": "417ab923-9866-412e-8442-842afcf72bb9",
"sales_organization_code": "sample string 6",
"reference_back_office": "sample string 7",
"modified_dateutc": "2026-08-14T04:29:18.3026205+00:00",
"db_currency_id": "dab3f7a7-179e-4704-b7f8-426f1c5d4747",
"db_currency_code": "sample string 10"
},
"company_type_id": "5e62a60e-e12e-48a9-82d4-6b82ac51c1d8",
"company_type_name": "sample string 32",
"company_type": {
"id": "f3c89296-7615-48c4-a945-257109def278",
"name": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "362e3285-209b-4235-9e00-e7ca8498b117",
"sales_organization_code": "sample string 5"
},
"db_language_id": "fa6602d6-0136-4948-84eb-3303743a8b16",
"db_language_code": "sample string 34",
"code": "sample string 35",
"article_price_label_id": "c98abf59-cfc2-48c4-8ed0-5ec59196edf5",
"article_price_label_code": "sample string 37",
"db_payment_method_id": "56fe3a96-f871-442a-995d-242bd1974cdb",
"db_payment_method_reference_back_office": "sample string 39",
"db_payment_methods": {
"id": "802af53a-faf4-439b-9c6f-af758340245b",
"name": "sample string 2",
"description": "sample string 3",
"reference_back_office": "sample string 4",
"activated": true,
"modified_dateutc": "2026-08-14T04:29:18.3026205+00:00"
},
"company_sector_id": "97ae018e-1bd5-4ef4-bf88-b3e34fae968f",
"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": "b7b381d1-1e0c-4e9a-a432-a3658798caf9",
"service_manager_user_code": "sample string 52",
"finance_manager_user_id": "bf0443f8-cac2-4fea-ade2-4b58e376f9e5",
"finance_manager_user_code": "sample string 54",
"account_manager_user_id": "74ef23be-fb6b-45e1-b8de-d8781bf96f43",
"account_manager_user_code": "sample string 56",
"company_status_id": "478e7a86-7be7-43bb-920d-101a71953c6d",
"invoice_email_to": "sample string 58",
"modified_dateutc": "2026-08-14T04:29:18.3026205+00:00",
"id2": 60
},
"db_language_id": "0920fafa-4820-4330-a8c7-079d22a4243c",
"db_language_code": "sample string 7",
"db_title_id": "b206cbce-06dc-4795-8ed6-2230fa678954",
"archived": true,
"functions": "sample string 10",
"e_login": "sample string 11",
"e_password": "sample string 12",
"notes": "sample string 13",
"birthdate": "2026-08-14T04:29:18.3026205+00:00",
"create_date": "2026-08-14T04:29:18.3026205+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": "2026-08-14T04:29:18.3026205+00:00"
},
"modified_dateutc": "2026-08-14T04:29:18.3026205+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": "1c2e6502-bea2-4475-94e7-83168ae602f4",
"_parent_id": "fd7e25cb-8d63-4be9-a350-094a4ec7419b",
"_parent_reference_back_office": "sample string 3",
"project_status_id": "a1de62f6-6cae-45aa-be67-49f83225d782",
"company_id": "6c05ea0a-f0f8-4782-a226-dfdf09582207",
"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": "1c0413ce-5b8e-4121-bc8e-4ca92036c540",
"db_country_code": "sample string 17",
"street2": "sample string 18",
"latitude_decimal": 1.0,
"longitude_decimal": 1.0,
"contact_id": "4035ea36-2975-4dd4-b402-ba65cacdd322",
"contact_reference_back_office": "sample string 20",
"contact": {
"id": "c8a9f6dc-1c00-45c4-a8ae-c1eaf48a1d05",
"firstname": "sample string 2",
"lastname": "sample string 3",
"company_id": "4799d363-2658-40c8-b00e-9b442956c9b0",
"company_code": "sample string 5",
"company": {
"id": "3fd32a8c-7a58-45df-b209-a344a9355165",
"is_client": true,
"is_supplier": true,
"archived": true,
"name": "sample string 5",
"notes": "sample string 6",
"create_date": "2026-08-14T04:29:18.3026205+00:00",
"sales_territory_id": "d99840a2-cd9b-409e-9e9c-517cda4668c0",
"sales_territory_code": "sample string 9",
"sales_territory": {
"id": "7c5c9def-c182-48c8-b1f5-ecf38b4fe692",
"code": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "9c594e3a-63e5-404c-99f6-0e7cc8f0376e",
"sales_organization_code": "sample string 5",
"sales_organization": {
"id": "5877528f-0a95-4257-b697-81ddc9dfed88",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "b450ae15-0792-45a4-aa69-0c7dfcb0903d",
"db_currency_id": "bd5e74c5-0408-4d21-8e08-2a5bc91384e6",
"db_language_id": "dad6b9fb-0c4a-4911-938d-7c728125ac72",
"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": "2026-08-14T04:29:18.3026205+00:00"
},
"modified_dateutc": "2026-08-14T04:29:18.3026205+00:00"
},
"marketing_segment_id": "240f3260-fe18-496d-9858-e098d767c216",
"marketing_segment_code": "sample string 11",
"sales_organization_id": "0d9c99f0-88e6-4807-b362-4731a3a7bb91",
"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": "2396e4c1-95f9-4c4f-b365-efb5b6fc736e",
"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": "86249045-34e9-4f24-8d25-da1e8fb0bf24",
"db_country_code": "sample string 28",
"feelist_id": "8644151e-d53f-4c03-a0a8-84c0a93917ba",
"feelist_reference_back_office": "sample string 30",
"feelist": {
"id": "fadfbea0-7551-4ca3-9e7c-10dacc6caf8e",
"name": "sample string 2",
"description": "sample string 3",
"is_default": true,
"default_price": 1.0,
"sales_organization_id": "38e5e025-47b6-4710-bbdb-31d79aa20f55",
"sales_organization_code": "sample string 6",
"reference_back_office": "sample string 7",
"modified_dateutc": "2026-08-14T04:29:18.3026205+00:00",
"db_currency_id": "4eaf1351-2905-419b-9faf-ab7de48e4edb",
"db_currency_code": "sample string 10"
},
"company_type_id": "7ebe08c8-93cb-4852-9f4e-088b32b5adcf",
"company_type_name": "sample string 32",
"company_type": {
"id": "200c9dd0-844d-432a-bfa0-32dbe7469bc0",
"name": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "b744b6f5-d092-459d-8d9b-1fda84a691b2",
"sales_organization_code": "sample string 5"
},
"db_language_id": "f4d6ba91-e885-4204-8163-b53cd89103d4",
"db_language_code": "sample string 34",
"code": "sample string 35",
"article_price_label_id": "6452a1ac-7c1a-480a-8bd5-5ffed5fcda3e",
"article_price_label_code": "sample string 37",
"db_payment_method_id": "cf7a35a9-54c6-4100-a520-121bd2a104ee",
"db_payment_method_reference_back_office": "sample string 39",
"db_payment_methods": {
"id": "07f28838-357a-4a5f-8e1a-3de3545917bf",
"name": "sample string 2",
"description": "sample string 3",
"reference_back_office": "sample string 4",
"activated": true,
"modified_dateutc": "2026-08-14T04:29:18.3026205+00:00"
},
"company_sector_id": "a056ff6d-1832-4028-8a1c-1ccb0f103c6c",
"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": "8d330205-9a95-4a46-a9fe-12086d834dd1",
"service_manager_user_code": "sample string 52",
"finance_manager_user_id": "d40f84ab-bb75-4fca-84a4-edb0c218a4e0",
"finance_manager_user_code": "sample string 54",
"account_manager_user_id": "d21058cb-4ba9-4fc6-85e8-caf186244abe",
"account_manager_user_code": "sample string 56",
"company_status_id": "74897f9f-167e-49e6-8e17-5d1357b66448",
"invoice_email_to": "sample string 58",
"modified_dateutc": "2026-08-14T04:29:18.3026205+00:00",
"id2": 60
},
"db_language_id": "e7198e1c-9f6c-43c5-a31b-fd03134f3aab",
"db_language_code": "sample string 7",
"db_title_id": "0caccf03-fdfc-4f3a-84c0-817990d80678",
"archived": true,
"functions": "sample string 10",
"e_login": "sample string 11",
"e_password": "sample string 12",
"notes": "sample string 13",
"birthdate": "2026-08-14T04:29:18.3026205+00:00",
"create_date": "2026-08-14T04:29:18.3026205+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": "2026-08-14T04:29:18.3026205+00:00"
},
"modified_dateutc": "2026-08-14T04:29:18.3026205+00:00",
"id2": 22
}