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": "4291a091-cacf-4fc8-bfe5-85d2254958ad",
"_parent_id": "b4a451f2-237e-49d2-bcbc-bb83fa8321b4",
"_parent_reference_back_office": "sample string 3",
"project_status_id": "e358e865-06f6-4812-b05a-452ab3e8a5f8",
"company_id": "01b3751d-0a9c-4497-8335-992c55b74f75",
"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": "019bf26a-9cb8-49ed-b029-e1f6f55e0548",
"db_country_code": "sample string 17",
"street2": "sample string 18",
"latitude_decimal": 1.0,
"longitude_decimal": 1.0,
"contact_id": "50a06b2e-d027-4da7-888b-25f7cccd7219",
"contact_reference_back_office": "sample string 20",
"contact": {
"id": "9b3ccd49-8740-41dc-8b9b-f984949bdd64",
"firstname": "sample string 2",
"lastname": "sample string 3",
"company_id": "bb99a19f-a454-4311-8852-19a0c571720f",
"company_code": "sample string 5",
"company": {
"id": "d1416be3-665e-4fec-8398-638148e744c7",
"is_client": true,
"is_supplier": true,
"archived": true,
"name": "sample string 5",
"notes": "sample string 6",
"create_date": "2026-06-25T21:36:39.8283943+00:00",
"sales_territory_id": "3d58caa7-7b81-4345-a38c-075c9f935814",
"sales_territory_code": "sample string 9",
"sales_territory": {
"id": "d372c046-9ae0-48c0-b55d-60d4f269b9c8",
"code": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "fc285ff2-660e-4ee6-bea9-ebbd7f3bcc22",
"sales_organization_code": "sample string 5",
"sales_organization": {
"id": "b4b43575-f587-40ea-b103-eb8c7b14c13d",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "ce8d2349-c46f-4dbf-8574-3c8b7a6de25c",
"db_currency_id": "c489fcfb-e0e7-472e-86e5-fa25162caf31",
"db_language_id": "8ac9dec6-df51-4e4e-9b3c-ade1bbcf451a",
"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-06-25T21:36:39.8283943+00:00"
},
"modified_dateutc": "2026-06-25T21:36:39.8283943+00:00"
},
"marketing_segment_id": "d62db0e1-ee51-4639-b64f-9bf7d88500b5",
"marketing_segment_code": "sample string 11",
"sales_organization_id": "6d6f773e-ab30-4419-a196-963a60ac8822",
"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": "bd9dea91-e60f-4f52-8b41-73273df6cced",
"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": "2959a884-c65f-4478-bedb-283dd904fa45",
"db_country_code": "sample string 28",
"feelist_id": "8680bcc3-1b1d-4b3d-96bb-079083864c81",
"feelist_reference_back_office": "sample string 30",
"feelist": {
"id": "3161ddcd-484d-44bc-8a3d-3ece5a02bd3a",
"name": "sample string 2",
"description": "sample string 3",
"is_default": true,
"default_price": 1.0,
"sales_organization_id": "257dbc8f-5b89-491e-896e-6ce17a31c34f",
"sales_organization_code": "sample string 6",
"reference_back_office": "sample string 7",
"modified_dateutc": "2026-06-25T21:36:39.8283943+00:00",
"db_currency_id": "0f6ec230-4742-4faa-83ea-9a38c79db7d2",
"db_currency_code": "sample string 10"
},
"company_type_id": "944222f2-f14a-4e97-825b-66e2cd8b8c15",
"company_type_name": "sample string 32",
"company_type": {
"id": "e9becf52-c4ad-4c6b-b10b-6cd43af9ffaa",
"name": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "5c3990dd-9104-4d1d-b0ed-03721f1b6d08",
"sales_organization_code": "sample string 5"
},
"db_language_id": "e191be7a-ba08-4545-afa8-baa8def41ecd",
"db_language_code": "sample string 34",
"code": "sample string 35",
"article_price_label_id": "3b43212d-12e8-4a2f-be01-b9f0eda6f0e7",
"article_price_label_code": "sample string 37",
"db_payment_method_id": "0533786f-0c4e-4ddb-83c2-9e8826cd0072",
"db_payment_method_reference_back_office": "sample string 39",
"db_payment_methods": {
"id": "45a4c452-36f4-4411-9984-e9d006f7dc7a",
"name": "sample string 2",
"description": "sample string 3",
"reference_back_office": "sample string 4",
"activated": true,
"modified_dateutc": "2026-06-25T21:36:39.8283943+00:00"
},
"company_sector_id": "f18e1c02-90bd-42d3-bea0-d8eade545caa",
"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": "235e31b3-768a-46d1-a633-045d4160b8a5",
"service_manager_user_code": "sample string 52",
"finance_manager_user_id": "43ab830d-d32c-4121-9765-9798a05386f4",
"finance_manager_user_code": "sample string 54",
"account_manager_user_id": "f307b30c-f5fd-4e34-8dbf-894810015614",
"account_manager_user_code": "sample string 56",
"company_status_id": "329e234e-262d-49db-86be-72e968b5f877",
"invoice_email_to": "sample string 58",
"modified_dateutc": "2026-06-25T21:36:39.8283943+00:00",
"id2": 60
},
"db_language_id": "4ce41c54-8f99-4ca2-b65e-1358cb1a4972",
"db_language_code": "sample string 7",
"db_title_id": "c8f58e57-bf4d-4a71-9221-65bbad244aa2",
"archived": true,
"functions": "sample string 10",
"e_login": "sample string 11",
"e_password": "sample string 12",
"notes": "sample string 13",
"birthdate": "2026-06-25T21:36:39.8283943+00:00",
"create_date": "2026-06-25T21:36:39.8283943+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-06-25T21:36:39.8283943+00:00"
},
"modified_dateutc": "2026-06-25T21:36:39.8283943+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": "3a005982-77cf-4ead-8aea-b79f9e122e1b",
"_parent_id": "855b9f67-fdb3-4e66-8389-7b5ec4a94bdc",
"_parent_reference_back_office": "sample string 3",
"project_status_id": "c91c104d-ad1d-4b10-bda8-b0eaa56a67a7",
"company_id": "3e5de086-08c1-47a8-91a4-9b4c7f081293",
"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": "c1716b11-0f9f-4d04-b334-3adec3065bf2",
"db_country_code": "sample string 17",
"street2": "sample string 18",
"latitude_decimal": 1.0,
"longitude_decimal": 1.0,
"contact_id": "b0f8ddb1-6e37-4aaa-bf2e-0d49c16dfd90",
"contact_reference_back_office": "sample string 20",
"contact": {
"id": "3a9af422-390e-409a-be6a-b7a4ce642fdf",
"firstname": "sample string 2",
"lastname": "sample string 3",
"company_id": "c30b0508-7bd0-4f8c-aeec-0e7f462a77d5",
"company_code": "sample string 5",
"company": {
"id": "614b22b6-ae1a-4804-bbe9-d0a439d4a64c",
"is_client": true,
"is_supplier": true,
"archived": true,
"name": "sample string 5",
"notes": "sample string 6",
"create_date": "2026-06-25T21:36:39.8283943+00:00",
"sales_territory_id": "292d501c-8925-4f60-8a00-1fa72d7e6595",
"sales_territory_code": "sample string 9",
"sales_territory": {
"id": "78a2b9c8-dab9-40e5-b55f-8ff638cd47ac",
"code": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "364510fc-5cea-4685-b787-a54626b49366",
"sales_organization_code": "sample string 5",
"sales_organization": {
"id": "e74b80c8-05eb-4c57-a1fb-ae7d20fe8cb5",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "f3810888-cc97-4592-a0e6-cb99a71909d7",
"db_currency_id": "5cad8c81-2741-4acb-8e20-a716574a8acc",
"db_language_id": "b04fb1ed-8dab-4bc2-b2d3-4abe83e52ed3",
"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-06-25T21:36:39.8283943+00:00"
},
"modified_dateutc": "2026-06-25T21:36:39.8283943+00:00"
},
"marketing_segment_id": "57508e78-854a-4bfb-bd9c-831ce2bfb8d9",
"marketing_segment_code": "sample string 11",
"sales_organization_id": "76dce20c-10b7-4dfd-a4f9-897c1299b283",
"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": "e1962f22-484a-4646-9f64-abdb8d6b8271",
"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": "91eb63c5-f04b-44e2-8744-8885dbc7ca49",
"db_country_code": "sample string 28",
"feelist_id": "bea87dc9-5cb4-4612-ab74-32a247c0efd4",
"feelist_reference_back_office": "sample string 30",
"feelist": {
"id": "5b4d722a-4b70-424c-9e95-2eb652cef0fe",
"name": "sample string 2",
"description": "sample string 3",
"is_default": true,
"default_price": 1.0,
"sales_organization_id": "a8677497-78fe-4559-9e4e-39a6ec3e099f",
"sales_organization_code": "sample string 6",
"reference_back_office": "sample string 7",
"modified_dateutc": "2026-06-25T21:36:39.8283943+00:00",
"db_currency_id": "1eb381c3-dd93-46b8-beda-11bfbac5a6b7",
"db_currency_code": "sample string 10"
},
"company_type_id": "6989de4c-5431-4d18-9295-6b7f2fdaf1dd",
"company_type_name": "sample string 32",
"company_type": {
"id": "25155a63-33ab-4153-9c38-267c4f768aad",
"name": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "630e470e-cc53-4804-9818-8d07615d4274",
"sales_organization_code": "sample string 5"
},
"db_language_id": "471cf769-549c-4c8f-a03c-2d7dc3c3b53e",
"db_language_code": "sample string 34",
"code": "sample string 35",
"article_price_label_id": "0148d4d6-1eb6-4c6b-9389-9e7f08d706fb",
"article_price_label_code": "sample string 37",
"db_payment_method_id": "5f07ff87-457f-47e1-8f80-c8b900eab693",
"db_payment_method_reference_back_office": "sample string 39",
"db_payment_methods": {
"id": "3f352fcc-9bf2-48e5-b2ba-c68cd22d8d8d",
"name": "sample string 2",
"description": "sample string 3",
"reference_back_office": "sample string 4",
"activated": true,
"modified_dateutc": "2026-06-25T21:36:39.8283943+00:00"
},
"company_sector_id": "d1f86e67-1044-428e-81c9-81610d6659e0",
"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": "ad326baa-e405-4402-881c-3566136ad736",
"service_manager_user_code": "sample string 52",
"finance_manager_user_id": "90a12642-1b1e-438e-9926-223708047fed",
"finance_manager_user_code": "sample string 54",
"account_manager_user_id": "cb12bb61-88b3-4988-a223-5e4913cdcaf7",
"account_manager_user_code": "sample string 56",
"company_status_id": "935098fe-4f76-4af7-bed2-51579a78d2f0",
"invoice_email_to": "sample string 58",
"modified_dateutc": "2026-06-25T21:36:39.8283943+00:00",
"id2": 60
},
"db_language_id": "02130be9-24dc-478d-ab1f-e45d0d1fd6ea",
"db_language_code": "sample string 7",
"db_title_id": "279d832f-11da-4aa2-a7c8-956356b826d7",
"archived": true,
"functions": "sample string 10",
"e_login": "sample string 11",
"e_password": "sample string 12",
"notes": "sample string 13",
"birthdate": "2026-06-25T21:36:39.8283943+00:00",
"create_date": "2026-06-25T21:36:39.8283943+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-06-25T21:36:39.8283943+00:00"
},
"modified_dateutc": "2026-06-25T21:36:39.8283943+00:00",
"id2": 22
}