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": "203eb2da-e529-4e80-a2e3-3faa79f2e05e", "is_client": true, "is_supplier": true, "archived": true, "name": "sample string 5", "notes": "sample string 6", "create_date": "2025-06-05T18:51:09.2530593+00:00", "sales_territory_id": "8dfec464-80ce-4add-88bd-17874c898d01", "sales_territory_code": "sample string 9", "sales_territory": { "id": "d0ad0e10-0cef-4e8a-a80e-2a4c5b511b17", "code": "sample string 2", "description": "sample string 3", "sales_organization_id": "0e5a7fd3-9dec-43fd-b4ff-69cfa4c4b700", "sales_organization_code": "sample string 5", "sales_organization": { "id": "fd0030d6-13dc-4c09-b449-0bc7fb21f9fa", "code": "sample string 2", "name": "sample string 3", "description": "sample string 4", "db_country_id": "b3b971fd-020c-4dee-b287-cbb5bde09778", "db_currency_id": "34315a3c-b050-4768-a0a5-e35774092863", "db_language_id": "e5b76c26-b7a9-44fe-b159-ea19bd8b259e", "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-06-05T18:51:09.2530593+00:00" }, "modified_dateutc": "2025-06-05T18:51:09.2530593+00:00" }, "marketing_segment_id": "cc3fff8f-75df-46e6-be31-dfb8cd914cf9", "marketing_segment_code": "sample string 11", "sales_organization_id": "24edf75d-5139-4d45-92ce-df17b11b30d2", "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": "2e1f45a5-3650-424b-a2d4-7946b878f9b0", "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": "0428ee18-2d12-497a-801b-8a39db11aa33", "db_country_code": "sample string 28", "feelist_id": "e7a6ecf2-b734-4513-9ec9-b58ba0c2db9e", "feelist_reference_back_office": "sample string 30", "feelist": { "id": "ca6d1b80-148a-434c-8e81-97f8ec971002", "name": "sample string 2", "description": "sample string 3", "is_default": true, "default_price": 1.0, "sales_organization_id": "7c235a58-969e-484a-8f78-9a8ded373f5f", "sales_organization_code": "sample string 6", "reference_back_office": "sample string 7", "modified_dateutc": "2025-06-05T18:51:09.2530593+00:00", "db_currency_id": "8bc6b765-1f17-46a1-9add-f7675efb2427", "db_currency_code": "sample string 10" }, "company_type_id": "e3940268-14f2-441d-a11d-f9c208167b88", "company_type_name": "sample string 32", "company_type": { "id": "312371be-0a2c-40ca-9cb8-7979e51dee96", "name": "sample string 2", "description": "sample string 3", "sales_organization_id": "f0d6ebac-6b08-476a-9a4f-c044af262007", "sales_organization_code": "sample string 5" }, "db_language_id": "837090c9-399a-4db2-b774-c3aed83d1262", "db_language_code": "sample string 34", "code": "sample string 35", "article_price_label_id": "2fe7ff64-b82f-41fd-97fb-3a8cfbfa2290", "article_price_label_code": "sample string 37", "db_payment_method_id": "79e9545c-2104-43f2-ba7b-92a7cfc6f21d", "db_payment_method_reference_back_office": "sample string 39", "db_payment_methods": { "id": "0108ab1c-00f8-4bda-bed2-8d17e8ac6157", "name": "sample string 2", "description": "sample string 3", "reference_back_office": "sample string 4", "activated": true, "modified_dateutc": "2025-06-05T18:51:09.2530593+00:00" }, "company_sector_id": "5d43dd85-1b82-4fc7-a70e-6988f77fd312", "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": "a1364f96-d316-42d3-867c-4f93ba552794", "service_manager_user_code": "sample string 52", "finance_manager_user_id": "ab4a64c5-7a59-45ba-a563-64e0de6ab428", "finance_manager_user_code": "sample string 54", "account_manager_user_id": "458faede-6851-4945-98f5-a5430f0c74a1", "account_manager_user_code": "sample string 56", "company_status_id": "3d6c800c-a22b-4120-868b-52a70cb3d17f", "invoice_email_to": "sample string 58", "modified_dateutc": "2025-06-05T18:51:09.2530593+00:00", "id2": 60 }