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": "c74704b1-3ad0-4c85-97ab-ed72aa19d2f3",
"_parent_id": "061bb4b3-0f05-45d7-9916-e767e063f4d8",
"_parent_reference_back_office": "sample string 3",
"project_status_id": "c9769c5d-eae4-4aa4-b2c5-e39f8a9a2f21",
"company_id": "8007b2f0-ef6b-4f48-91c7-8ef9bf39fdba",
"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": "bea0ead0-aae7-496f-97b5-aa37dde851eb",
"db_country_code": "sample string 17",
"street2": "sample string 18",
"latitude_decimal": 1.0,
"longitude_decimal": 1.0,
"contact_id": "e36213ef-5fb4-4a09-95d8-38182ddfd4ae",
"contact_reference_back_office": "sample string 20",
"contact": {
"id": "6e77b48b-87a8-445f-bc52-a5f627bf9fbb",
"firstname": "sample string 2",
"lastname": "sample string 3",
"company_id": "471542a6-d82e-4aea-aa4d-72c3a35ba133",
"company_code": "sample string 5",
"company": {
"id": "0d16d1f0-9dd1-4444-a8fd-c4f3ed007fb7",
"is_client": true,
"is_supplier": true,
"archived": true,
"name": "sample string 5",
"notes": "sample string 6",
"create_date": "2026-09-13T08:39:01.7616238+00:00",
"sales_territory_id": "cf8731ff-ed22-4d12-90a9-16d27585fc85",
"sales_territory_code": "sample string 9",
"sales_territory": {
"id": "83095e1a-6935-4e9d-923b-41eed60de044",
"code": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "674fb56f-299e-4923-bd29-37b6a68d0bf4",
"sales_organization_code": "sample string 5",
"sales_organization": {
"id": "e0288348-c502-4579-b9b8-743c673190ae",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "5d0861b4-cf91-4ed5-b77c-a91f02a29e5b",
"db_currency_id": "3f70f126-6ae8-4ae6-9a65-c50065ddc7e0",
"db_language_id": "0cd16af1-8013-4464-b160-8b8e3b3ca2ce",
"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-09-13T08:39:01.7616238+00:00"
},
"modified_dateutc": "2026-09-13T08:39:01.7616238+00:00"
},
"marketing_segment_id": "1529188a-4064-4f2f-97a8-967820865d6a",
"marketing_segment_code": "sample string 11",
"sales_organization_id": "e183ebe9-7911-41e3-8fc4-dc75b61584e6",
"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": "01263086-3afa-4d41-a3eb-6d55b23b3846",
"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": "7539a38b-7d59-4668-8c8d-2ff2931ddc56",
"db_country_code": "sample string 28",
"feelist_id": "2f67213a-8c26-425a-be36-ed57c84f4dda",
"feelist_reference_back_office": "sample string 30",
"feelist": {
"id": "56b86189-bf98-4727-97c2-9c30d92ca6c5",
"name": "sample string 2",
"description": "sample string 3",
"is_default": true,
"default_price": 1.0,
"sales_organization_id": "8e2fa50a-5876-4862-a69d-59e3e43e809a",
"sales_organization_code": "sample string 6",
"reference_back_office": "sample string 7",
"modified_dateutc": "2026-09-13T08:39:01.7616238+00:00",
"db_currency_id": "78b6ff6c-ee4f-4a75-9ae8-a1de9e450c7f",
"db_currency_code": "sample string 10"
},
"company_type_id": "03a81291-1267-4602-ac2a-2ae3529787b6",
"company_type_name": "sample string 32",
"company_type": {
"id": "e52b4778-6139-41e5-998c-18d82ac3504a",
"name": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "164ab2a4-2b36-4e34-8adc-f462eabe217f",
"sales_organization_code": "sample string 5"
},
"db_language_id": "c64e34c1-0d9b-4b68-942a-b1c0cbbe9ead",
"db_language_code": "sample string 34",
"code": "sample string 35",
"article_price_label_id": "f39691cd-cee3-4f62-b07f-9b5f25bdcad5",
"article_price_label_code": "sample string 37",
"db_payment_method_id": "f21d0a71-ef85-4e68-97b3-ccd87773ba9c",
"db_payment_method_reference_back_office": "sample string 39",
"db_payment_methods": {
"id": "4d492b56-ba5e-4022-8902-6c1e41c1e633",
"name": "sample string 2",
"description": "sample string 3",
"reference_back_office": "sample string 4",
"activated": true,
"modified_dateutc": "2026-09-13T08:39:01.7616238+00:00"
},
"company_sector_id": "65b5c5d5-81df-497f-bfec-2797b87487f4",
"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": "eb892bd1-54de-43dc-a02a-9535a0fbfc1d",
"service_manager_user_code": "sample string 52",
"finance_manager_user_id": "faa1d224-1393-4ac8-9b16-0e0a10c0995f",
"finance_manager_user_code": "sample string 54",
"account_manager_user_id": "e339d0a1-53d3-4c9b-b42d-ca34d47893c8",
"account_manager_user_code": "sample string 56",
"company_status_id": "d8d8f7ea-9de0-42ff-87c2-9b23c1d6aab0",
"invoice_email_to": "sample string 58",
"modified_dateutc": "2026-09-13T08:39:01.7616238+00:00",
"id2": 60
},
"db_language_id": "a60ca2d1-d263-4daa-9c9b-f83bae8b519a",
"db_language_code": "sample string 7",
"db_title_id": "60e3526d-c246-4bd6-866b-e65e43ada377",
"archived": true,
"functions": "sample string 10",
"e_login": "sample string 11",
"e_password": "sample string 12",
"notes": "sample string 13",
"birthdate": "2026-09-13T08:39:01.7616238+00:00",
"create_date": "2026-09-13T08:39:01.7616238+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-09-13T08:39:01.7616238+00:00"
},
"modified_dateutc": "2026-09-13T08:39:01.7616238+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": "c1f4c6a5-d7fd-40c8-8803-aa8a36ebf9ba",
"_parent_id": "e69dfa06-1689-4dc7-9891-9dd2a3704d51",
"_parent_reference_back_office": "sample string 3",
"project_status_id": "00ba01a0-58d1-4a21-b3a4-2ef55f318e77",
"company_id": "100d2fd0-d902-4029-af0d-e65ed146dee0",
"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": "f7088a51-5539-4464-ac54-18a91f629e9d",
"db_country_code": "sample string 17",
"street2": "sample string 18",
"latitude_decimal": 1.0,
"longitude_decimal": 1.0,
"contact_id": "c877a509-60ed-4720-b1b5-af024136433a",
"contact_reference_back_office": "sample string 20",
"contact": {
"id": "c7497ff1-d5c4-473a-a173-257363c7b265",
"firstname": "sample string 2",
"lastname": "sample string 3",
"company_id": "e5294a2d-8a8b-4606-9ab7-eb66dff01c26",
"company_code": "sample string 5",
"company": {
"id": "23949a6c-bac2-42ab-920e-23790a7728e0",
"is_client": true,
"is_supplier": true,
"archived": true,
"name": "sample string 5",
"notes": "sample string 6",
"create_date": "2026-09-13T08:39:01.7772511+00:00",
"sales_territory_id": "5afdf069-4177-4901-87de-73eeebf922a4",
"sales_territory_code": "sample string 9",
"sales_territory": {
"id": "664809cc-6480-4484-a1c1-6b5b01a0c6e5",
"code": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "f46e8eea-da38-4fde-8512-57039dc2b5e6",
"sales_organization_code": "sample string 5",
"sales_organization": {
"id": "8a68658c-5064-4514-8680-c9d6238408c2",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "6f1043cb-77d3-46dc-9bbf-3b0e6360fe7a",
"db_currency_id": "befdf901-7488-4d24-9daa-db6f44c161de",
"db_language_id": "2730f7cb-9516-4cb9-8b8e-408578aa8a94",
"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-09-13T08:39:01.7772511+00:00"
},
"modified_dateutc": "2026-09-13T08:39:01.7772511+00:00"
},
"marketing_segment_id": "35f29ced-e7fd-4e08-9825-f7ffa5d11024",
"marketing_segment_code": "sample string 11",
"sales_organization_id": "77c98914-ccb4-4d62-a611-82110142d38b",
"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": "5798200b-7411-4e55-bcb6-777ed00312f3",
"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": "6a6c5fff-2e6e-48a2-9082-6d0aae2273bf",
"db_country_code": "sample string 28",
"feelist_id": "277aa0bf-a50d-48b3-967e-9ab85187fe6b",
"feelist_reference_back_office": "sample string 30",
"feelist": {
"id": "ec1382dc-2e36-4da9-acce-7d744195c570",
"name": "sample string 2",
"description": "sample string 3",
"is_default": true,
"default_price": 1.0,
"sales_organization_id": "28516eba-3072-4bc3-9538-1803eac5c1b0",
"sales_organization_code": "sample string 6",
"reference_back_office": "sample string 7",
"modified_dateutc": "2026-09-13T08:39:01.7928744+00:00",
"db_currency_id": "09988dca-d9bf-4ea1-bb2a-d282a33dfc71",
"db_currency_code": "sample string 10"
},
"company_type_id": "5fdadddd-00e7-4c7f-b5e0-b8736d635cbe",
"company_type_name": "sample string 32",
"company_type": {
"id": "0017a855-9c88-4852-a00c-ee79a2461443",
"name": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "03f84bb2-2d42-42dd-b2a1-62c5212045ab",
"sales_organization_code": "sample string 5"
},
"db_language_id": "5c4be751-aa66-4b6f-8c52-552d570ee01b",
"db_language_code": "sample string 34",
"code": "sample string 35",
"article_price_label_id": "218e646d-12a5-40d9-aff9-6b5d474606e6",
"article_price_label_code": "sample string 37",
"db_payment_method_id": "17222c80-a83a-4d7f-9a04-9cf2941026a6",
"db_payment_method_reference_back_office": "sample string 39",
"db_payment_methods": {
"id": "022d3927-9aeb-48a1-b76b-2a5cf9d52f0b",
"name": "sample string 2",
"description": "sample string 3",
"reference_back_office": "sample string 4",
"activated": true,
"modified_dateutc": "2026-09-13T08:39:01.7928744+00:00"
},
"company_sector_id": "eb710ec1-7c84-48fe-b531-eb8a451e6f02",
"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": "73be6bb8-3f44-4a71-8001-369b8121672a",
"service_manager_user_code": "sample string 52",
"finance_manager_user_id": "699c5985-d078-4a1d-a853-3836b031a7d6",
"finance_manager_user_code": "sample string 54",
"account_manager_user_id": "30c6dbfc-a0e3-40c7-b29f-20801d83cecb",
"account_manager_user_code": "sample string 56",
"company_status_id": "bec22005-d049-45ee-a333-489821f14ac9",
"invoice_email_to": "sample string 58",
"modified_dateutc": "2026-09-13T08:39:01.7928744+00:00",
"id2": 60
},
"db_language_id": "9e78b9b5-bb3b-49a0-9601-963effea1b8b",
"db_language_code": "sample string 7",
"db_title_id": "69b03cba-02aa-4617-ad3b-a20987c41cde",
"archived": true,
"functions": "sample string 10",
"e_login": "sample string 11",
"e_password": "sample string 12",
"notes": "sample string 13",
"birthdate": "2026-09-13T08:39:01.7928744+00:00",
"create_date": "2026-09-13T08:39:01.7928744+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-09-13T08:39:01.7928744+00:00"
},
"modified_dateutc": "2026-09-13T08:39:01.7928744+00:00",
"id2": 22
}