Retrieves the company with the specified key
Request Information
URI Parameters :
Name | Description | Type | Additional information |
---|---|---|---|
id | globally unique identifier |
Required |
Body Parameters :
None.
Response Information
Resource Description :
IHttpActionResult
companyName | Description | Type | Additional information |
---|---|---|---|
id |
Primary Key |
globally unique identifier |
Required |
is_client |
SALES : Indicate if can be used for ordering |
boolean | |
is_supplier |
SERVICES : indicate if this company is a supplier |
boolean | |
archived |
Archive this company to not have it anymore on the search |
boolean | |
name | string |
Required Max length: 64 |
|
notes |
Notes/Remark field |
string | |
create_date |
Creation date+time |
date | |
sales_territory_id |
Territory of the company (Sales+Services).If more than one sales_territory exists, then it must be filled |
globally unique identifier | |
sales_territory_code |
Embedded entity "sales_territory" using ERP PK when adding/updating company |
string | |
sales_territory |
Embedded entity "sales_territory" using node when adding/updating company |
sales_territory | |
marketing_segment_id |
Marketing Segment of the company (Sales (Visit frequency logic) +Services (Planning Jobs To Be Planned) ) |
globally unique identifier | |
marketing_segment_code |
Embedded entity "marketing_segment" using ERP PK when adding/updating company |
string | |
marketing_segment |
Embedded entity "marketing_segment" using node when adding/updating company |
marketing_segment | |
sales_organization_id |
Organization on which belongs the company.If more than one sales_organization exists, then it must be filled |
globally unique identifier | |
sales_organization_code |
Embedded entity "sales_organization" using ERP PK when adding/updating company |
string | |
sales_organization |
Embedded entity "sales_organization" using node when adding/updating company |
sales_organization | |
company_sales_status_code |
Foreign key of company_sales_status using code. Use "Normal,CreditRisk, BlockedbyCM or OrderBlocked" |
string | |
vat_reg_code |
VAT number |
string |
Max length: 50 |
is_working_address |
Services : If False, you cannot create project/installation on this company.Default=true |
boolean | |
parent_id |
Reference to a parent company (in case of Child/Parent) when adding/updating company |
globally unique identifier | |
parent_company_code |
Embedded entity "company" for parent (in case of Child/Parent) using ERP PK when adding/updating company |
string | |
parent_company |
Embedded entity "company" for parent (in case of Child/Parent) when adding/updating company |
company | |
phone |
Phone number of the company |
string |
Max length: 50 |
fax |
Fax number of the company |
string |
Max length: 50 |
url |
URL of the company website |
string |
Max length: 255 |
|
string |
Max length: 250 |
|
street |
Address:Street |
string |
Max length: 100 |
street_number |
Address:Street Number. If your ERP doesn't have this field, then only use field "street" and disable the street number on Odyssee/Admin/Impl Settings/Global Settings:Hide Street Number |
string |
Max length: 50 |
city |
Address:City |
string |
Max length: 50 |
zip |
Address:Zip |
string |
Max length: 50 |
db_country_id |
Address:Country |
globally unique identifier | |
db_country_code |
Address:CountryCode entity using international code when adding/updating company |
string | |
feelist_id |
FeeList activated for the company (On Service, Feelist determines the price of the invoicable timesheets) |
globally unique identifier | |
feelist_reference_back_office |
Embedded entity "feelist" using ERP PK when adding/updating company |
string | |
feelist |
Embedded entity "feelist" using node when adding/updating company |
feelist | |
company_type_id |
Company Type |
globally unique identifier | |
company_type_name |
Embedded entity "company_type" using ERP PK when adding/updating company |
string | |
company_type |
Embedded entity "company_type" using node when adding/updating company |
company_type | |
db_language_id |
Language of the company.If empty, will use the default on the system |
globally unique identifier | |
db_language_code |
Language code entity using international isocode when adding/updating company |
string | |
code |
Field used for Embedded entity (store there your ERP PK) |
string |
Max length: 50 |
article_price_label_id |
Foreign key of article price label |
globally unique identifier | |
article_price_label_code |
Embedded entity "article price label" using ERP PK when adding/updating |
string | |
article_price_label |
Embedded entity "article price label" when adding/updating |
article_price_label | |
db_payment_method_id |
Embedded entity "db payment methods" using ERP PK when adding/updating company |
globally unique identifier | |
db_payment_method_reference_back_office |
Embedded entity "db payment methods" using ERP PK when adding/updating company |
string | |
db_payment_methods |
Embedded entity "db payment methods" using ERP PK when adding/updating company |
db_payment_methods | |
company_sector_id |
Foreign key to company_sector |
globally unique identifier | |
company_sector_code |
Embedded code for the company_sector using ERP PK when adding/updating |
string | |
company_sector |
Embedded entity for the company_sector using the key from an external system when adding/updating object |
company_sector | |
is_lead |
Indicate that company is not already a customer |
boolean | |
is_subcontractor |
For Service, that company is one of your subcontractors |
boolean | |
latitude |
Decimal coordonate for the latitude. (-1;-1) means invalid and (0;0) means not already geo-encoded |
decimal number | |
longitude |
Decimal coordonate for the longitude. (-1;-1) means invalid and (0;0) means not already geo-encoded |
decimal number | |
street2 |
Additional information on the address not part of the postal address |
string | |
bic_code |
bic code |
string | |
specialities |
specialities |
string | |
register_number |
register_number |
string | |
register_city |
register_city |
string | |
bankaccount |
Bank account of the company. |
string | |
mobile |
Mobile number of the company |
string |
Max length: 50 |
service_manager_user_id |
ID of the service manager. Auto selected user when creating location, installation. Used also inside communication and tags |
globally unique identifier | |
service_manager_user_code |
Embedded code of the service manager. Auto selected user when creating location, installation. Used also inside communication and tags |
string | |
service_manager_user |
Embedded entity of the service manager. Auto selected user when creating location, installation. Used also inside communication and tags |
user | |
finance_manager_user_id |
ID of the finance manager. Only used inside communication and tags |
globally unique identifier | |
finance_manager_user_code |
Embedded code of the finance manager. Only used inside communication and tags |
string | |
finance_manager_user |
Embedded entity of the finance manager. Only used inside communication and tags |
user | |
account_manager_user_id |
ID of the account manager. Only used inside communication and tags |
globally unique identifier | |
account_manager_user_code |
Embedded code of the account manager. Only used inside communication and tags |
string | |
account_manager_user |
Embedded entity of the account manager. Only used inside communication and tags |
user | |
company_status_id |
Company Status |
globally unique identifier | |
invoice_email_to |
Email to send invoice |
string | |
modified_dateutc |
Readonly system field managed by database, filled with GetUtcDate when adding,updating |
date | |
id2 |
Internal ID (numeric) |
integer |
Response Formats
application/json, text/json
{ "id": "f301f37a-ea9d-4f90-bfd8-5d058c0f0e74", "is_client": true, "is_supplier": true, "archived": true, "name": "sample string 5", "notes": "sample string 6", "create_date": "2025-10-07T07:33:31.5573465+00:00", "sales_territory_id": "853a333e-e911-43cd-be03-f00181fd1cf8", "sales_territory_code": "sample string 9", "sales_territory": { "id": "a4770257-fe03-4aea-b9f6-c88c2728539e", "code": "sample string 2", "description": "sample string 3", "sales_organization_id": "7c554356-3f5a-42fa-a561-de6d0859b868", "sales_organization_code": "sample string 5", "sales_organization": { "id": "e37866f6-9d47-4c0a-a6ec-34b19a7c39f3", "code": "sample string 2", "name": "sample string 3", "description": "sample string 4", "db_country_id": "d03b816d-c48f-4975-bfe7-71a73ead5409", "db_currency_id": "815ba2ca-70f5-42d4-adbe-f87c186db020", "db_language_id": "4b099663-d4bd-423e-89c9-3972e7e892dc", "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-10-07T07:33:31.5573465+00:00" }, "modified_dateutc": "2025-10-07T07:33:31.5573465+00:00" }, "marketing_segment_id": "aa472f0e-c4d1-4497-b67c-fc1daba094d7", "marketing_segment_code": "sample string 11", "sales_organization_id": "92602de6-b824-4cef-9920-e027422678fc", "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": "997c35f1-2e27-47d5-970e-4b11aa14e2eb", "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": "6c0463c3-18fd-4a0c-ab9a-396b8fc45d09", "db_country_code": "sample string 28", "feelist_id": "fe349084-5d21-44ed-bc6c-13b403527e61", "feelist_reference_back_office": "sample string 30", "feelist": { "id": "8150686a-25dc-4f38-b02c-dfd271be2833", "name": "sample string 2", "description": "sample string 3", "is_default": true, "default_price": 1.0, "sales_organization_id": "b59619d5-463a-42cb-bad0-44ce3c5f3a44", "sales_organization_code": "sample string 6", "reference_back_office": "sample string 7", "modified_dateutc": "2025-10-07T07:33:31.5573465+00:00", "db_currency_id": "bf635c63-3a8a-4cfa-9ac9-b4f4d646f6b0", "db_currency_code": "sample string 10" }, "company_type_id": "4538d555-c9c7-498d-8627-8f2da73534a4", "company_type_name": "sample string 32", "company_type": { "id": "62a2e873-c139-4fca-a0f7-6ac6b471ab4e", "name": "sample string 2", "description": "sample string 3", "sales_organization_id": "b8474318-3d94-47d2-ba34-e36d07842b2d", "sales_organization_code": "sample string 5" }, "db_language_id": "38e54e6c-98dc-4d19-a278-d3ca977d7e21", "db_language_code": "sample string 34", "code": "sample string 35", "article_price_label_id": "89044478-8c01-4f16-b840-8e4987573302", "article_price_label_code": "sample string 37", "db_payment_method_id": "05f3226b-9521-4d96-b9c6-a623d43989a8", "db_payment_method_reference_back_office": "sample string 39", "db_payment_methods": { "id": "1d945c83-1435-48b0-af9b-7c4db4dff8b0", "name": "sample string 2", "description": "sample string 3", "reference_back_office": "sample string 4", "activated": true, "modified_dateutc": "2025-10-07T07:33:31.5573465+00:00" }, "company_sector_id": "cd7aa844-4bbd-440a-b7ab-ef2975cb1756", "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": "354ba47e-2559-48c0-a5d5-236dfd83b02e", "service_manager_user_code": "sample string 52", "finance_manager_user_id": "edff404f-5042-4cd2-ae83-883a51f0019f", "finance_manager_user_code": "sample string 54", "account_manager_user_id": "b593ad2b-76b9-4489-8014-6732dcb361c6", "account_manager_user_code": "sample string 56", "company_status_id": "123b90c3-4cce-458e-b7fa-503f2e26ca3d", "invoice_email_to": "sample string 58", "modified_dateutc": "2025-10-07T07:33:31.5573465+00:00", "id2": 60 }