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": "b660a3a5-d1c7-46af-b96f-6ba18f02cc36",
"_parent_id": "33c38ed2-b7ee-4aee-95aa-03cd076fd14c",
"_parent_reference_back_office": "sample string 3",
"project_status_id": "b8d921f5-df70-4284-9d0b-5926251c29e1",
"company_id": "85f66a8d-b382-4a95-b053-ac82136fec55",
"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": "14fd17b4-8f07-420d-ad1a-7ad488816187",
"db_country_code": "sample string 17",
"street2": "sample string 18",
"latitude_decimal": 1.0,
"longitude_decimal": 1.0,
"contact_id": "3fefda09-97cd-419b-b0c3-055ba959adf3",
"contact_reference_back_office": "sample string 20",
"contact": {
"id": "160561c8-3ec2-4825-bc56-bf0663139dae",
"firstname": "sample string 2",
"lastname": "sample string 3",
"company_id": "3de42c4e-69e7-4a2f-8023-b11f4cc19c2b",
"company_code": "sample string 5",
"company": {
"id": "70a2f8d4-8d17-4a74-b45a-f02f76a33764",
"is_client": true,
"is_supplier": true,
"archived": true,
"name": "sample string 5",
"notes": "sample string 6",
"create_date": "2025-12-15T17:51:08.779107+00:00",
"sales_territory_id": "d1f7eee2-5674-4b7d-ba0c-ea00f4c8866c",
"sales_territory_code": "sample string 9",
"sales_territory": {
"id": "8b82a8c1-db3e-494d-814f-47f433e2b643",
"code": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "54e032cb-1409-45f9-941c-e13d12232786",
"sales_organization_code": "sample string 5",
"sales_organization": {
"id": "7a865f94-aada-4b21-958f-fd61e69b7726",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "5d5af74e-16b3-43db-a4b6-9dba2dd287d9",
"db_currency_id": "edde41b2-0b35-4ea9-b15e-6f15d71490e7",
"db_language_id": "0901bcec-0c06-4b94-a3dd-f3ac8f515a41",
"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-12-15T17:51:08.779107+00:00"
},
"modified_dateutc": "2025-12-15T17:51:08.779107+00:00"
},
"marketing_segment_id": "68a29dae-e222-415e-962d-23e85b048de6",
"marketing_segment_code": "sample string 11",
"sales_organization_id": "2f8154a7-ac81-4a32-ada2-fdec944e586a",
"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": "f147d71c-c164-4b92-865c-777f53a35615",
"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": "1f5c8b33-c97f-4c9d-a864-009762d69f59",
"db_country_code": "sample string 28",
"feelist_id": "d79f072d-caba-4f6a-8521-a4cc9ff783e0",
"feelist_reference_back_office": "sample string 30",
"feelist": {
"id": "246d2e73-b42e-46a6-bc43-0ed659d7a328",
"name": "sample string 2",
"description": "sample string 3",
"is_default": true,
"default_price": 1.0,
"sales_organization_id": "f565c48d-8319-4293-a8b3-4cc8ba7aad5e",
"sales_organization_code": "sample string 6",
"reference_back_office": "sample string 7",
"modified_dateutc": "2025-12-15T17:51:08.779107+00:00",
"db_currency_id": "c81d9621-1324-4280-a6fd-dcb8f09a82a0",
"db_currency_code": "sample string 10"
},
"company_type_id": "465bee67-57db-472a-a8e2-c04bb7725647",
"company_type_name": "sample string 32",
"company_type": {
"id": "29b93650-5cac-4afb-9fd1-b0fa52ca6e7f",
"name": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "1c62d981-942f-4f45-839a-2e4b238417d7",
"sales_organization_code": "sample string 5"
},
"db_language_id": "e506d208-756b-4085-9a92-53b149996fbd",
"db_language_code": "sample string 34",
"code": "sample string 35",
"article_price_label_id": "e16b92ea-b3a4-48b6-9e2b-934a8c08ceb3",
"article_price_label_code": "sample string 37",
"db_payment_method_id": "a0fc8f3e-0504-4310-8a70-812d14960eab",
"db_payment_method_reference_back_office": "sample string 39",
"db_payment_methods": {
"id": "f8069e8f-4614-4d4d-996d-2f19e382f63e",
"name": "sample string 2",
"description": "sample string 3",
"reference_back_office": "sample string 4",
"activated": true,
"modified_dateutc": "2025-12-15T17:51:08.779107+00:00"
},
"company_sector_id": "7a46bb41-f0c6-43fb-b1ca-d6174633fd11",
"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": "6936b522-b966-4921-9f1c-42892e908f22",
"service_manager_user_code": "sample string 52",
"finance_manager_user_id": "98b817c4-c6f3-437b-beeb-ac94162d67a7",
"finance_manager_user_code": "sample string 54",
"account_manager_user_id": "dafb96ca-3cdd-4fec-8164-46a7c39322dd",
"account_manager_user_code": "sample string 56",
"company_status_id": "8a048416-52ab-4337-aee2-3040d9b6b7d7",
"invoice_email_to": "sample string 58",
"modified_dateutc": "2025-12-15T17:51:08.779107+00:00",
"id2": 60
},
"db_language_id": "7a26c225-cc9c-4190-baa5-cad3e0e581e5",
"db_language_code": "sample string 7",
"db_title_id": "f6a455e7-b7b7-4af6-a6ec-7ec965493563",
"archived": true,
"functions": "sample string 10",
"e_login": "sample string 11",
"e_password": "sample string 12",
"notes": "sample string 13",
"birthdate": "2025-12-15T17:51:08.779107+00:00",
"create_date": "2025-12-15T17:51:08.779107+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-12-15T17:51:08.779107+00:00"
},
"modified_dateutc": "2025-12-15T17:51:08.779107+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": "6601e358-9af0-4d6e-b020-977dfd73bec2",
"_parent_id": "86f6a1f5-7a87-4501-8e53-4dc9797664d1",
"_parent_reference_back_office": "sample string 3",
"project_status_id": "6c1df13f-1b85-4335-8c6a-f4ad539e764f",
"company_id": "28b73625-0042-4ca1-9e81-95af29b3c2de",
"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": "07677dcc-b5cb-4226-899b-eb763580b2aa",
"db_country_code": "sample string 17",
"street2": "sample string 18",
"latitude_decimal": 1.0,
"longitude_decimal": 1.0,
"contact_id": "2761e13c-e75a-474f-9c82-78ae8387ea39",
"contact_reference_back_office": "sample string 20",
"contact": {
"id": "82578f17-9596-4fb4-a90c-38435e0f1d02",
"firstname": "sample string 2",
"lastname": "sample string 3",
"company_id": "d28c5e16-d00d-4332-95bf-c6ab8aef2700",
"company_code": "sample string 5",
"company": {
"id": "41dc3f52-f0ec-44e7-9b4f-638bf2a7a87b",
"is_client": true,
"is_supplier": true,
"archived": true,
"name": "sample string 5",
"notes": "sample string 6",
"create_date": "2025-12-15T17:51:08.8259797+00:00",
"sales_territory_id": "a1923b6f-3517-43ef-b8b5-c24a1a67f74d",
"sales_territory_code": "sample string 9",
"sales_territory": {
"id": "282ad6b8-3df9-4915-8f86-b63fce515d11",
"code": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "00d61bd6-6c19-4899-923b-fe2bafcc8960",
"sales_organization_code": "sample string 5",
"sales_organization": {
"id": "b79d9f16-715c-4d45-9164-cb5315c852a7",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "c1094b5c-a0fa-4dd1-b376-8fd3b156b9a8",
"db_currency_id": "f67463ef-96e1-456e-ae05-292cffd27a93",
"db_language_id": "fabc3193-8140-4ae8-9184-af470d5f2672",
"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-12-15T17:51:08.8259797+00:00"
},
"modified_dateutc": "2025-12-15T17:51:08.8259797+00:00"
},
"marketing_segment_id": "78703cf9-6c8a-467c-bc19-7fdea0ceeabe",
"marketing_segment_code": "sample string 11",
"sales_organization_id": "a2452c89-4931-4177-a568-56a5c2c1fce7",
"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": "e94c779b-d9b5-462c-b6b6-579d978ec6c0",
"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": "5794d1ab-1592-4c0e-8cd8-8278b60e0452",
"db_country_code": "sample string 28",
"feelist_id": "9c58a683-2098-42ad-8f9d-96a98a96c08a",
"feelist_reference_back_office": "sample string 30",
"feelist": {
"id": "daf5ffb2-101c-4572-91b2-d240097d0ef9",
"name": "sample string 2",
"description": "sample string 3",
"is_default": true,
"default_price": 1.0,
"sales_organization_id": "2b976763-ce39-4c4d-9a02-dcecb34a8483",
"sales_organization_code": "sample string 6",
"reference_back_office": "sample string 7",
"modified_dateutc": "2025-12-15T17:51:08.8259797+00:00",
"db_currency_id": "f79974dd-7aeb-4579-b08a-a7ad4771d1eb",
"db_currency_code": "sample string 10"
},
"company_type_id": "e1e95219-cf93-4cfe-aec5-40ab06882353",
"company_type_name": "sample string 32",
"company_type": {
"id": "f00e49ce-be02-41b7-9ac8-655855daf990",
"name": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "95cb6b38-33a8-4fbe-ade6-2162aceda840",
"sales_organization_code": "sample string 5"
},
"db_language_id": "d4352928-a03a-4f65-ac33-ffbc8cfd1743",
"db_language_code": "sample string 34",
"code": "sample string 35",
"article_price_label_id": "1131c3c9-662f-464a-91fd-46f6c5c31618",
"article_price_label_code": "sample string 37",
"db_payment_method_id": "310f8689-5df2-4860-b555-2ece90196d47",
"db_payment_method_reference_back_office": "sample string 39",
"db_payment_methods": {
"id": "0a3469bc-f78c-4b28-8408-376f2d16cb10",
"name": "sample string 2",
"description": "sample string 3",
"reference_back_office": "sample string 4",
"activated": true,
"modified_dateutc": "2025-12-15T17:51:08.8259797+00:00"
},
"company_sector_id": "e486881a-1a2f-458a-bd1e-cfba9a3f6428",
"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": "418f0215-211b-47b9-9439-f78d01232591",
"service_manager_user_code": "sample string 52",
"finance_manager_user_id": "380aeee5-a692-461c-83ea-00ebb310b3fa",
"finance_manager_user_code": "sample string 54",
"account_manager_user_id": "32819b18-3554-49e5-a089-632d4a221cca",
"account_manager_user_code": "sample string 56",
"company_status_id": "f812688d-0f20-48aa-adaf-a33e8df847f0",
"invoice_email_to": "sample string 58",
"modified_dateutc": "2025-12-15T17:51:08.8259797+00:00",
"id2": 60
},
"db_language_id": "afc8b1ce-bb50-4c8e-9e89-7e8d787853ed",
"db_language_code": "sample string 7",
"db_title_id": "fbc557fc-0bf2-491b-bda9-28763af1c666",
"archived": true,
"functions": "sample string 10",
"e_login": "sample string 11",
"e_password": "sample string 12",
"notes": "sample string 13",
"birthdate": "2025-12-15T17:51:08.8259797+00:00",
"create_date": "2025-12-15T17:51:08.8259797+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-12-15T17:51:08.8259797+00:00"
},
"modified_dateutc": "2025-12-15T17:51:08.8259797+00:00",
"id2": 22
}