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": "6b8d5a0e-6ec8-417d-8677-ecabf7aaeeb4",
"_parent_id": "767908fb-b98d-4d89-8f15-a0bc46ca1cb6",
"_parent_reference_back_office": "sample string 3",
"project_status_id": "c4c4187d-991e-4229-9413-f14f4d7eac3b",
"company_id": "cf54d871-1319-4888-ad1f-c084195af55d",
"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": "1387abf8-c202-470c-9ea2-3abacf98830d",
"db_country_code": "sample string 17",
"street2": "sample string 18",
"latitude_decimal": 1.0,
"longitude_decimal": 1.0,
"contact_id": "f0070cf2-b28e-4bb0-95ee-88815af8bc73",
"contact_reference_back_office": "sample string 20",
"contact": {
"id": "ca957284-7504-4150-a685-d3a568fed19f",
"firstname": "sample string 2",
"lastname": "sample string 3",
"company_id": "6d4ff4dc-6ae0-43bd-ae04-28968a0293f1",
"company_code": "sample string 5",
"company": {
"id": "84c2e4f2-c6dd-449a-95c8-ecc151532110",
"is_client": true,
"is_supplier": true,
"archived": true,
"name": "sample string 5",
"notes": "sample string 6",
"create_date": "2025-05-08T18:36:10.8216938+00:00",
"sales_territory_id": "b89803e9-5fed-4e40-a95d-7379d4fcb583",
"sales_territory_code": "sample string 9",
"sales_territory": {
"id": "fec00a3c-3939-45ed-8691-958e480ccf82",
"code": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "2de8f1b7-c3e5-42d9-8bc1-adb6590c3283",
"sales_organization_code": "sample string 5",
"sales_organization": {
"id": "c10abef5-3462-4f7f-ae51-fb914dfcc38a",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "faaf32d9-7607-4f2f-ad8d-1efde345aab2",
"db_currency_id": "4de007f2-6d4d-4441-b79c-f8a0fd67fdc8",
"db_language_id": "621e1674-1bc2-49d8-bd4d-5934ebdff34b",
"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-05-08T18:36:10.8216938+00:00"
},
"modified_dateutc": "2025-05-08T18:36:10.8216938+00:00"
},
"marketing_segment_id": "2cc55118-9b4a-431e-958b-dffe7b4e1f26",
"marketing_segment_code": "sample string 11",
"sales_organization_id": "feb8b3cd-14f7-4d05-84ef-395a7b6d3fac",
"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": "7cc49fa7-48aa-44e2-abcd-85bc2f068771",
"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": "f87618f9-d90f-4762-b2bc-a1e017de7be1",
"db_country_code": "sample string 28",
"feelist_id": "49c1fbcd-5d52-4382-ae1f-5f00de9e0769",
"feelist_reference_back_office": "sample string 30",
"feelist": {
"id": "4f4ee8eb-ed06-4676-b421-a029660479fc",
"name": "sample string 2",
"description": "sample string 3",
"is_default": true,
"default_price": 1.0,
"sales_organization_id": "5aa794f8-a6e0-4046-8eae-4bbb5243defe",
"sales_organization_code": "sample string 6",
"reference_back_office": "sample string 7",
"modified_dateutc": "2025-05-08T18:36:10.8216938+00:00",
"db_currency_id": "b892aebe-d858-4290-9897-908c324ffb4f",
"db_currency_code": "sample string 10"
},
"company_type_id": "f39bada7-0615-4648-aef3-e5e83f09ef59",
"company_type_name": "sample string 32",
"company_type": {
"id": "7d6ee578-4e59-4d5d-8d4e-a86bfc7b32a0",
"name": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "8f66489c-021b-4f99-9f4e-5ec98f73e4c5",
"sales_organization_code": "sample string 5"
},
"db_language_id": "ae116a2a-a230-4c29-bea2-a281e9cbc4c2",
"db_language_code": "sample string 34",
"code": "sample string 35",
"article_price_label_id": "daf6f13c-37ca-4e04-8a35-d46011929e4c",
"article_price_label_code": "sample string 37",
"db_payment_method_id": "6f0bb366-87f2-4a2e-b21a-97e6d62fc13a",
"db_payment_method_reference_back_office": "sample string 39",
"db_payment_methods": {
"id": "e0c8d726-e96e-445d-a25a-e7d5db64d49e",
"name": "sample string 2",
"description": "sample string 3",
"reference_back_office": "sample string 4",
"activated": true,
"modified_dateutc": "2025-05-08T18:36:10.8216938+00:00"
},
"company_sector_id": "fad5231d-fabc-4b40-b669-6b3b88614d74",
"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": "66483933-8a7a-4bb7-84f8-80414d850410",
"service_manager_user_code": "sample string 52",
"finance_manager_user_id": "d3e6c7f9-ef3c-42a7-a82f-21b354674ab7",
"finance_manager_user_code": "sample string 54",
"account_manager_user_id": "cdf2562c-d4d3-4579-917b-78d6d866bc3b",
"account_manager_user_code": "sample string 56",
"company_status_id": "0213949e-a055-4ed3-a65d-e7389c512060",
"invoice_email_to": "sample string 58",
"modified_dateutc": "2025-05-08T18:36:10.8216938+00:00",
"id2": 60
},
"db_language_id": "5a959bf4-a1b6-4e28-9eee-f9f52aaf0419",
"db_language_code": "sample string 7",
"db_title_id": "1b14a053-2896-4872-aebc-f242d4d01694",
"archived": true,
"functions": "sample string 10",
"e_login": "sample string 11",
"e_password": "sample string 12",
"notes": "sample string 13",
"birthdate": "2025-05-08T18:36:10.8216938+00:00",
"create_date": "2025-05-08T18:36:10.8216938+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-05-08T18:36:10.8216938+00:00"
},
"modified_dateutc": "2025-05-08T18:36:10.8216938+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": "3a5a68b5-16e5-4f8e-985e-24b1f08c65d7",
"_parent_id": "7d5720f6-a86c-40f6-b4b4-389208484561",
"_parent_reference_back_office": "sample string 3",
"project_status_id": "e22a94e7-200b-4040-ac53-e91033894883",
"company_id": "602f3132-9e45-498c-8fad-b456fb04baee",
"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": "057dc629-4cb8-455c-ab7e-f8f01d70bd3b",
"db_country_code": "sample string 17",
"street2": "sample string 18",
"latitude_decimal": 1.0,
"longitude_decimal": 1.0,
"contact_id": "829e64fb-51de-4379-ba77-f11f281d4e1a",
"contact_reference_back_office": "sample string 20",
"contact": {
"id": "32dc9e9e-ebd3-479c-8e8a-99ca93496b6e",
"firstname": "sample string 2",
"lastname": "sample string 3",
"company_id": "a0b8a249-0976-4aab-a2f4-dc8c72babf52",
"company_code": "sample string 5",
"company": {
"id": "35a5b5a7-e889-4502-9f76-978263edabca",
"is_client": true,
"is_supplier": true,
"archived": true,
"name": "sample string 5",
"notes": "sample string 6",
"create_date": "2025-05-08T18:36:10.8216938+00:00",
"sales_territory_id": "068f01f6-3651-4028-80ba-57f4bc836c3e",
"sales_territory_code": "sample string 9",
"sales_territory": {
"id": "9bfd033f-069d-4738-8fd3-f43bf8a8fac2",
"code": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "d6fe1296-fd70-4017-b2b5-d95c246d8208",
"sales_organization_code": "sample string 5",
"sales_organization": {
"id": "3e96bad4-a24a-40e5-ba89-84366d2c5c5b",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "8228b42c-8b16-47de-a1ea-c74118536114",
"db_currency_id": "345406b4-2e87-4710-80f8-227734511b64",
"db_language_id": "795dbe29-0f95-42b2-a98a-55fda76db68a",
"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-05-08T18:36:10.8216938+00:00"
},
"modified_dateutc": "2025-05-08T18:36:10.8216938+00:00"
},
"marketing_segment_id": "0e01f480-3fe1-45e7-9313-f800c3e63f8a",
"marketing_segment_code": "sample string 11",
"sales_organization_id": "dfd449af-9cde-417a-9aa9-38a73b452ed5",
"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": "17d6ea53-dfa2-4472-82c0-62051310881a",
"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": "a48f898d-90bf-45fa-a548-03f13905933a",
"db_country_code": "sample string 28",
"feelist_id": "08b724c6-c6fe-476c-b640-aecbd9463d88",
"feelist_reference_back_office": "sample string 30",
"feelist": {
"id": "9a4e0749-677c-4108-ac38-cb62c6a32e8a",
"name": "sample string 2",
"description": "sample string 3",
"is_default": true,
"default_price": 1.0,
"sales_organization_id": "cbc6a33b-8f83-4ab6-a119-40c0d006ec2a",
"sales_organization_code": "sample string 6",
"reference_back_office": "sample string 7",
"modified_dateutc": "2025-05-08T18:36:10.8216938+00:00",
"db_currency_id": "812dc82b-770c-4f0a-b1e6-eab487ec0400",
"db_currency_code": "sample string 10"
},
"company_type_id": "70ee1d65-d27d-400a-8829-e503ec228050",
"company_type_name": "sample string 32",
"company_type": {
"id": "f7497664-bb3d-47fa-9251-fcabdb70a09b",
"name": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "99c2b50b-6bda-4444-b49f-d69e9cd28b55",
"sales_organization_code": "sample string 5"
},
"db_language_id": "988531a7-1950-4ee3-8d31-324c510f8b26",
"db_language_code": "sample string 34",
"code": "sample string 35",
"article_price_label_id": "55556b90-0906-4814-9cea-b01573afb321",
"article_price_label_code": "sample string 37",
"db_payment_method_id": "b2d70a97-9c89-4a3e-9250-53bd121e9039",
"db_payment_method_reference_back_office": "sample string 39",
"db_payment_methods": {
"id": "9461d168-f1f7-4f30-9fd1-74162c3d7356",
"name": "sample string 2",
"description": "sample string 3",
"reference_back_office": "sample string 4",
"activated": true,
"modified_dateutc": "2025-05-08T18:36:10.8216938+00:00"
},
"company_sector_id": "fa639138-a115-402b-a801-f4a38850c184",
"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": "43d38a8d-a854-4946-9bda-e12d26c6a912",
"service_manager_user_code": "sample string 52",
"finance_manager_user_id": "95d7a4b0-13a5-49d1-a295-970fe5fd2f1a",
"finance_manager_user_code": "sample string 54",
"account_manager_user_id": "d11fa47e-75bb-42fb-a2f6-7a61ec1b7463",
"account_manager_user_code": "sample string 56",
"company_status_id": "174be5f3-b434-426b-b204-30eb343a839e",
"invoice_email_to": "sample string 58",
"modified_dateutc": "2025-05-08T18:36:10.8216938+00:00",
"id2": 60
},
"db_language_id": "d0f9d11e-c7aa-4d63-bf7e-604822089b91",
"db_language_code": "sample string 7",
"db_title_id": "2f65a779-b495-4dcf-bd94-7068a172fdbd",
"archived": true,
"functions": "sample string 10",
"e_login": "sample string 11",
"e_password": "sample string 12",
"notes": "sample string 13",
"birthdate": "2025-05-08T18:36:10.8216938+00:00",
"create_date": "2025-05-08T18:36:10.8216938+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-05-08T18:36:10.8216938+00:00"
},
"modified_dateutc": "2025-05-08T18:36:10.8216938+00:00",
"id2": 22
}