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": "a3bdc7a9-aa2c-4aa5-abfc-e1c905450079",
"_parent_id": "671ba8b9-91d0-4479-b8f7-9df1ff9486ec",
"_parent_reference_back_office": "sample string 3",
"project_status_id": "75e6a05b-30a9-4842-83cd-8f2273d7ad2b",
"company_id": "edbdcca2-a57f-41dd-b0ac-16fd20c318b3",
"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": "8f79a344-02c9-4229-ba6d-f93b792ccbb7",
"db_country_code": "sample string 17",
"street2": "sample string 18",
"latitude_decimal": 1.0,
"longitude_decimal": 1.0,
"contact_id": "9cb2193c-3a13-4124-b139-4bc566c4cc53",
"contact_reference_back_office": "sample string 20",
"contact": {
"id": "fc52cddb-ad89-4faf-ba6d-3b0f7eb708c9",
"firstname": "sample string 2",
"lastname": "sample string 3",
"company_id": "b115cb9a-3b4f-4618-926d-f4c7e7b59c4a",
"company_code": "sample string 5",
"company": {
"id": "f2210ffa-facd-45f5-93e8-e14c028910b3",
"is_client": true,
"is_supplier": true,
"archived": true,
"name": "sample string 5",
"notes": "sample string 6",
"create_date": "2025-11-04T13:29:39.7480952+00:00",
"sales_territory_id": "934885a5-f247-4eb7-85d7-24bbdfb61bf8",
"sales_territory_code": "sample string 9",
"sales_territory": {
"id": "10828a49-846a-4e26-a862-df3d0d23bb58",
"code": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "ed4e11a1-106b-49e6-a76a-db7989211647",
"sales_organization_code": "sample string 5",
"sales_organization": {
"id": "6721af4a-d832-480b-8b55-599695ea1514",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "6d4da9ee-827a-4292-8af2-edd02b9f0007",
"db_currency_id": "a7e2d133-59f5-4ab1-8ad5-de714468f86b",
"db_language_id": "bb61beeb-6c13-48fa-9fd5-8252276ca034",
"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-11-04T13:29:39.7480952+00:00"
},
"modified_dateutc": "2025-11-04T13:29:39.7480952+00:00"
},
"marketing_segment_id": "1262ebf2-54d1-4807-a72f-1a1114f6c57a",
"marketing_segment_code": "sample string 11",
"sales_organization_id": "e8b50b1b-9bcd-460e-be05-a37aec66bf75",
"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": "c913498e-50d0-4600-b43f-9af5cdb1d41d",
"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": "34287117-53c5-455c-86db-2a88209f6ac2",
"db_country_code": "sample string 28",
"feelist_id": "642e0f29-6aba-4266-8655-41f715f20cc3",
"feelist_reference_back_office": "sample string 30",
"feelist": {
"id": "7765c7ac-3726-4921-8098-5cb8070ed84e",
"name": "sample string 2",
"description": "sample string 3",
"is_default": true,
"default_price": 1.0,
"sales_organization_id": "5743554f-82e4-4823-be4a-80d10bfac8c3",
"sales_organization_code": "sample string 6",
"reference_back_office": "sample string 7",
"modified_dateutc": "2025-11-04T13:29:39.7480952+00:00",
"db_currency_id": "25e99d0b-3d76-4f95-893a-a8e1e4aead54",
"db_currency_code": "sample string 10"
},
"company_type_id": "3924016d-5bf3-4c91-a468-faa9b06861db",
"company_type_name": "sample string 32",
"company_type": {
"id": "20bed167-8f69-43ab-9f7b-b11b76cd234e",
"name": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "6d225384-ce0c-4c24-b690-30234418075e",
"sales_organization_code": "sample string 5"
},
"db_language_id": "7fa3b4c6-d602-433e-960a-ed9325275e64",
"db_language_code": "sample string 34",
"code": "sample string 35",
"article_price_label_id": "041fd8ac-113b-4286-ae30-8254c33e471b",
"article_price_label_code": "sample string 37",
"db_payment_method_id": "99d27f63-86fd-4d0b-9bd1-a519ba57dc83",
"db_payment_method_reference_back_office": "sample string 39",
"db_payment_methods": {
"id": "9de10d82-7efe-487e-9ac5-3e3f7b54bb74",
"name": "sample string 2",
"description": "sample string 3",
"reference_back_office": "sample string 4",
"activated": true,
"modified_dateutc": "2025-11-04T13:29:39.7480952+00:00"
},
"company_sector_id": "823eb820-797b-42f8-a0d1-491f794260c4",
"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": "b8a24602-93eb-44aa-bffe-c7d6e2434982",
"service_manager_user_code": "sample string 52",
"finance_manager_user_id": "5cd2a37a-5993-45f4-b54f-3d67eeff22de",
"finance_manager_user_code": "sample string 54",
"account_manager_user_id": "62410c17-5efc-45e2-a3ca-7844d5e1de3d",
"account_manager_user_code": "sample string 56",
"company_status_id": "47f6c24c-6ae4-4e33-8327-a8e846e189e4",
"invoice_email_to": "sample string 58",
"modified_dateutc": "2025-11-04T13:29:39.7480952+00:00",
"id2": 60
},
"db_language_id": "a9503765-e60a-4261-bc0f-c12533c87b4c",
"db_language_code": "sample string 7",
"db_title_id": "263d6ace-2370-41ac-a225-d7828a2507a7",
"archived": true,
"functions": "sample string 10",
"e_login": "sample string 11",
"e_password": "sample string 12",
"notes": "sample string 13",
"birthdate": "2025-11-04T13:29:39.7480952+00:00",
"create_date": "2025-11-04T13:29:39.7480952+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-11-04T13:29:39.7480952+00:00"
},
"modified_dateutc": "2025-11-04T13:29:39.7480952+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": "858e7097-0bc1-4d94-a599-3b49db744cc5",
"_parent_id": "e326d24b-797c-4324-b3cb-25b4af2ee4ef",
"_parent_reference_back_office": "sample string 3",
"project_status_id": "5e87b27a-d0c1-4b65-90c1-f9a2485339fa",
"company_id": "13473cf4-bb4d-4bd4-8518-d542f173fec0",
"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": "03b2b0ac-00f4-430d-bae2-effab92e63a9",
"db_country_code": "sample string 17",
"street2": "sample string 18",
"latitude_decimal": 1.0,
"longitude_decimal": 1.0,
"contact_id": "791f564e-e4de-46e3-9cfd-91891576c766",
"contact_reference_back_office": "sample string 20",
"contact": {
"id": "6456a8af-d1ee-4066-888f-4883a1057f9c",
"firstname": "sample string 2",
"lastname": "sample string 3",
"company_id": "17a4442b-4095-4995-b53e-1fb4203ba8c7",
"company_code": "sample string 5",
"company": {
"id": "5ab20851-d235-4fe4-95ca-120191d0a650",
"is_client": true,
"is_supplier": true,
"archived": true,
"name": "sample string 5",
"notes": "sample string 6",
"create_date": "2025-11-04T13:29:39.7480952+00:00",
"sales_territory_id": "89c14eb2-dd4f-4c37-8070-e051316620aa",
"sales_territory_code": "sample string 9",
"sales_territory": {
"id": "a57f829f-e569-41b9-927a-f46627fd07b3",
"code": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "9419d77f-6998-45f8-8be8-904d7de3008e",
"sales_organization_code": "sample string 5",
"sales_organization": {
"id": "d9f606bb-db07-40d6-ad29-cf0164369f94",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "5b515e09-73d3-4839-b59b-0a96a7d8a704",
"db_currency_id": "06438ce2-7d8b-4c1a-a184-e3a0b04dc20b",
"db_language_id": "6be356c6-5e82-4e59-b47a-df8ed04cd1d9",
"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-11-04T13:29:39.7480952+00:00"
},
"modified_dateutc": "2025-11-04T13:29:39.7480952+00:00"
},
"marketing_segment_id": "ad51f070-2349-470f-b4c0-6caf4af6ae8d",
"marketing_segment_code": "sample string 11",
"sales_organization_id": "89e6a2de-9cf5-41d7-9297-5d64dc2640e1",
"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": "a487bd51-66e9-4c40-9b03-3ae5e2842270",
"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": "e54038bd-05b0-4271-b90e-505c8e540998",
"db_country_code": "sample string 28",
"feelist_id": "3d9de270-045f-4c57-979f-111cba71d395",
"feelist_reference_back_office": "sample string 30",
"feelist": {
"id": "503fc596-90d5-4537-bdec-a0456e566dd3",
"name": "sample string 2",
"description": "sample string 3",
"is_default": true,
"default_price": 1.0,
"sales_organization_id": "4750d15a-0f30-4c28-b3ca-eced282f1dd0",
"sales_organization_code": "sample string 6",
"reference_back_office": "sample string 7",
"modified_dateutc": "2025-11-04T13:29:39.7480952+00:00",
"db_currency_id": "b7a2429b-7ff5-4962-98d5-84ede15b2cf9",
"db_currency_code": "sample string 10"
},
"company_type_id": "8812760c-dce7-4be5-a8ab-48f9840d20ee",
"company_type_name": "sample string 32",
"company_type": {
"id": "1be724ae-b59d-41db-a1f0-17aef7459b65",
"name": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "02df2b78-b898-4603-87a3-b19b377abb58",
"sales_organization_code": "sample string 5"
},
"db_language_id": "2fdbe96f-ef15-4fdc-85bc-2355528df9e0",
"db_language_code": "sample string 34",
"code": "sample string 35",
"article_price_label_id": "d2629fe4-437f-4ed9-aa7a-436278437bf2",
"article_price_label_code": "sample string 37",
"db_payment_method_id": "730f3362-5b4a-4e76-8c19-a7b0219472a9",
"db_payment_method_reference_back_office": "sample string 39",
"db_payment_methods": {
"id": "16020387-11ab-4c3f-b753-5def94a68793",
"name": "sample string 2",
"description": "sample string 3",
"reference_back_office": "sample string 4",
"activated": true,
"modified_dateutc": "2025-11-04T13:29:39.7480952+00:00"
},
"company_sector_id": "86a7a670-e0cb-4281-b5d6-6de4d34f3e1e",
"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": "2489b1da-8027-4465-a154-b46fb003c102",
"service_manager_user_code": "sample string 52",
"finance_manager_user_id": "bb34fc16-3a83-4e8b-bf82-b94dd93537db",
"finance_manager_user_code": "sample string 54",
"account_manager_user_id": "846f2088-4f02-432e-9a27-49227e488be3",
"account_manager_user_code": "sample string 56",
"company_status_id": "8c91fcc6-5c71-48cc-8ef6-66e0209516a9",
"invoice_email_to": "sample string 58",
"modified_dateutc": "2025-11-04T13:29:39.7480952+00:00",
"id2": 60
},
"db_language_id": "cdf6fe3d-c506-4f58-ad6d-cc28b23de031",
"db_language_code": "sample string 7",
"db_title_id": "93bc88fe-02c4-4cfc-b4b7-f082799ecc31",
"archived": true,
"functions": "sample string 10",
"e_login": "sample string 11",
"e_password": "sample string 12",
"notes": "sample string 13",
"birthdate": "2025-11-04T13:29:39.7480952+00:00",
"create_date": "2025-11-04T13:29:39.7480952+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-11-04T13:29:39.7480952+00:00"
},
"modified_dateutc": "2025-11-04T13:29:39.7480952+00:00",
"id2": 22
}