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": "ab8760db-bbca-4a60-bd81-5a9fbd38f4a9",
"_parent_id": "13e80818-8d01-4698-8156-94138a76aef3",
"_parent_reference_back_office": "sample string 3",
"project_status_id": "2ece5f87-1084-4a69-8112-883469080e22",
"company_id": "25372425-bb76-4312-952c-5f64838944be",
"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": "732a4337-f488-49ff-a1be-2bc919b19638",
"db_country_code": "sample string 17",
"street2": "sample string 18",
"latitude_decimal": 1.0,
"longitude_decimal": 1.0,
"contact_id": "c75fc899-5121-4742-ac50-39f7b6634223",
"contact_reference_back_office": "sample string 20",
"contact": {
"id": "86f3cf4c-d56b-4186-805d-0aae3b076663",
"firstname": "sample string 2",
"lastname": "sample string 3",
"company_id": "4fa86719-ae86-4146-9b10-09220686ca44",
"company_code": "sample string 5",
"company": {
"id": "a64f007a-dd24-46f7-99ac-d454e6b03024",
"is_client": true,
"is_supplier": true,
"archived": true,
"name": "sample string 5",
"notes": "sample string 6",
"create_date": "2025-09-03T18:53:26.8455889+00:00",
"sales_territory_id": "93f5bbcb-d5cc-4609-b09e-58603dd2707c",
"sales_territory_code": "sample string 9",
"sales_territory": {
"id": "9b70771b-73eb-4514-95e0-d518e76b6a6a",
"code": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "4424fa09-3134-4fb6-9800-9d41b9d99fb5",
"sales_organization_code": "sample string 5",
"sales_organization": {
"id": "b368e446-942e-4822-b92f-9b806b157f9f",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "7087d85e-01a3-44ed-a127-cb164c976a29",
"db_currency_id": "0b4ba950-8e2a-40e2-8413-8927b34512ce",
"db_language_id": "0550836d-1394-4aa7-8638-f10d15f2f830",
"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-09-03T18:53:26.8455889+00:00"
},
"modified_dateutc": "2025-09-03T18:53:26.8455889+00:00"
},
"marketing_segment_id": "a94627e7-355b-4997-a2e7-04a1ca118157",
"marketing_segment_code": "sample string 11",
"sales_organization_id": "5bd7c501-f6d8-4fce-b131-79b7b01a21bc",
"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": "bcddc4ae-5d46-4dc3-9ee4-481a0da1eb28",
"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": "aaec474a-0497-418b-8657-136a65af1c55",
"db_country_code": "sample string 28",
"feelist_id": "7ae2a3ac-1904-4437-a134-0a1ada14ca1d",
"feelist_reference_back_office": "sample string 30",
"feelist": {
"id": "23dfe1bc-85ef-4b0e-a057-9555ab9fcb89",
"name": "sample string 2",
"description": "sample string 3",
"is_default": true,
"default_price": 1.0,
"sales_organization_id": "4d94898a-bc70-4955-aa1b-da6503fa7609",
"sales_organization_code": "sample string 6",
"reference_back_office": "sample string 7",
"modified_dateutc": "2025-09-03T18:53:26.8455889+00:00",
"db_currency_id": "09f616b0-0250-4715-a6b8-a8ba9b9d7a81",
"db_currency_code": "sample string 10"
},
"company_type_id": "f42fbd3d-9aa1-4e50-b97d-81241e82c482",
"company_type_name": "sample string 32",
"company_type": {
"id": "5aa1cb3b-7066-4f0d-9774-afa1388ed5a4",
"name": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "eb521e44-c70f-4439-a9e2-bd756122031f",
"sales_organization_code": "sample string 5"
},
"db_language_id": "326cee19-bb1a-4050-94a8-5e3390eb53f0",
"db_language_code": "sample string 34",
"code": "sample string 35",
"article_price_label_id": "87f8fef4-a957-467c-adde-b987797f152a",
"article_price_label_code": "sample string 37",
"db_payment_method_id": "4c967c6d-ca88-416f-848f-fd89f0bc0691",
"db_payment_method_reference_back_office": "sample string 39",
"db_payment_methods": {
"id": "4fcdacd6-f167-4a9f-849f-f6e1e5660bfd",
"name": "sample string 2",
"description": "sample string 3",
"reference_back_office": "sample string 4",
"activated": true,
"modified_dateutc": "2025-09-03T18:53:26.8455889+00:00"
},
"company_sector_id": "c59d40b4-3919-4abb-be63-104a94f38836",
"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": "b1bf2f32-6f9f-45b4-b47f-1ae734ba6e72",
"service_manager_user_code": "sample string 52",
"finance_manager_user_id": "b4daf8db-fd30-4f3a-bd1c-e7fdd5e14e7c",
"finance_manager_user_code": "sample string 54",
"account_manager_user_id": "88a8dbe3-fda4-4b00-8b03-25e46e35a823",
"account_manager_user_code": "sample string 56",
"company_status_id": "45d0bdb7-65b4-481a-9981-2c193c5801bb",
"invoice_email_to": "sample string 58",
"modified_dateutc": "2025-09-03T18:53:26.8455889+00:00",
"id2": 60
},
"db_language_id": "fe821cd3-b528-427f-99c3-d13b1e4706e5",
"db_language_code": "sample string 7",
"db_title_id": "1b04edb7-2d29-4500-ad7c-bbb4ed1c652e",
"archived": true,
"functions": "sample string 10",
"e_login": "sample string 11",
"e_password": "sample string 12",
"notes": "sample string 13",
"birthdate": "2025-09-03T18:53:26.8455889+00:00",
"create_date": "2025-09-03T18:53:26.8455889+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-09-03T18:53:26.8455889+00:00"
},
"modified_dateutc": "2025-09-03T18:53:26.8455889+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": "af69dd2a-c554-4caa-8a09-589723708e47",
"_parent_id": "a4eebef8-afca-4fad-9f21-95f92c801948",
"_parent_reference_back_office": "sample string 3",
"project_status_id": "efa4aa0c-a8ec-46eb-9901-1b10c35d5091",
"company_id": "9a0a82d3-45e2-4788-b0d3-5f3de6e47d28",
"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": "f6981da9-9198-44c6-b477-99c67416aa56",
"db_country_code": "sample string 17",
"street2": "sample string 18",
"latitude_decimal": 1.0,
"longitude_decimal": 1.0,
"contact_id": "ce7051f9-8260-44d0-90bd-d0ea3816b69b",
"contact_reference_back_office": "sample string 20",
"contact": {
"id": "8732157d-79f0-4bba-9423-ee1831b4cacf",
"firstname": "sample string 2",
"lastname": "sample string 3",
"company_id": "c9b25fee-d91a-475a-ae15-73aa0251b7fd",
"company_code": "sample string 5",
"company": {
"id": "6c0fc8c8-66d0-4f2b-89b9-38e218074d93",
"is_client": true,
"is_supplier": true,
"archived": true,
"name": "sample string 5",
"notes": "sample string 6",
"create_date": "2025-09-03T18:53:26.8612139+00:00",
"sales_territory_id": "2e1b50dc-75ee-4f7f-adff-29fe4b05889c",
"sales_territory_code": "sample string 9",
"sales_territory": {
"id": "a18c096a-2330-4cc5-9f94-3622c9ee87bc",
"code": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "191eee32-f91c-47da-bb13-ad289778cd7b",
"sales_organization_code": "sample string 5",
"sales_organization": {
"id": "b706c772-a7c9-4235-bd12-fee09da98614",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "b27d404a-ee1c-4f57-881d-166769afe3e7",
"db_currency_id": "8b66eb36-9464-4ec3-8391-995ed1fc7bd8",
"db_language_id": "9298eec5-873c-4702-a1bb-be44ff8491b9",
"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-09-03T18:53:26.8612139+00:00"
},
"modified_dateutc": "2025-09-03T18:53:26.8612139+00:00"
},
"marketing_segment_id": "6abd53ab-f650-4cff-b34c-8638d93e1f61",
"marketing_segment_code": "sample string 11",
"sales_organization_id": "87349873-c9d2-4e6e-87c9-40d375bf7587",
"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": "b0eefda0-de96-491a-b6d8-d07a4b4880b1",
"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": "2b6efaa9-b689-45b5-b261-01d6d3363263",
"db_country_code": "sample string 28",
"feelist_id": "4f66ce6b-e4fe-4c7c-b67f-3f97cdfb7d25",
"feelist_reference_back_office": "sample string 30",
"feelist": {
"id": "dd7beb67-6c1b-4c08-a560-b615ff847513",
"name": "sample string 2",
"description": "sample string 3",
"is_default": true,
"default_price": 1.0,
"sales_organization_id": "b54bd87d-bd95-488b-a851-760eb115ca4a",
"sales_organization_code": "sample string 6",
"reference_back_office": "sample string 7",
"modified_dateutc": "2025-09-03T18:53:26.8612139+00:00",
"db_currency_id": "d0a9fd38-9303-4b65-8a27-e0e06aeb224f",
"db_currency_code": "sample string 10"
},
"company_type_id": "f2b2aa93-c2d5-4969-99db-298121d7f5c4",
"company_type_name": "sample string 32",
"company_type": {
"id": "f5db85a1-7024-4f84-9b01-614f6a85496b",
"name": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "edd52894-0335-48b2-ae1b-32233ef4ab50",
"sales_organization_code": "sample string 5"
},
"db_language_id": "8e1d3426-9950-4d34-b8f3-053f20bd1791",
"db_language_code": "sample string 34",
"code": "sample string 35",
"article_price_label_id": "df5e34b9-e63c-4122-9063-e041a1d70da9",
"article_price_label_code": "sample string 37",
"db_payment_method_id": "4e365b81-2022-45ad-ac8c-72bb2fcb38a4",
"db_payment_method_reference_back_office": "sample string 39",
"db_payment_methods": {
"id": "74622487-6223-4168-b5e7-1f015d825edb",
"name": "sample string 2",
"description": "sample string 3",
"reference_back_office": "sample string 4",
"activated": true,
"modified_dateutc": "2025-09-03T18:53:26.8612139+00:00"
},
"company_sector_id": "3296b885-bda1-4d11-97d0-919459d85954",
"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": "c12b709c-df1f-4134-8c6e-f46c19630773",
"service_manager_user_code": "sample string 52",
"finance_manager_user_id": "63ff3422-c441-430b-8266-c9f3c267f6d6",
"finance_manager_user_code": "sample string 54",
"account_manager_user_id": "ecd29e4a-640f-4491-905c-db606ddacfc2",
"account_manager_user_code": "sample string 56",
"company_status_id": "c49a4a37-f8e9-4c9f-9be5-ea781a277633",
"invoice_email_to": "sample string 58",
"modified_dateutc": "2025-09-03T18:53:26.8612139+00:00",
"id2": 60
},
"db_language_id": "f6737240-aa1c-47af-a14d-91269823d2d1",
"db_language_code": "sample string 7",
"db_title_id": "fdb00901-6b0a-4b43-942c-d3ced0e9da1d",
"archived": true,
"functions": "sample string 10",
"e_login": "sample string 11",
"e_password": "sample string 12",
"notes": "sample string 13",
"birthdate": "2025-09-03T18:53:26.8612139+00:00",
"create_date": "2025-09-03T18:53:26.8612139+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-09-03T18:53:26.8612139+00:00"
},
"modified_dateutc": "2025-09-03T18:53:26.8612139+00:00",
"id2": 22
}