Retrieves the company with the specified key

Request Information

URI Parameters :

NameDescriptionTypeAdditional information
id

globally unique identifier

Required

Body Parameters :

None.

Response Information

Resource Description :

IHttpActionResult

company
NameDescriptionTypeAdditional 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

email

email

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

Sample:
{
  "id": "7dbafacb-4e0a-4438-8d2c-bd18b48ec15d",
  "is_client": true,
  "is_supplier": true,
  "archived": true,
  "name": "sample string 5",
  "notes": "sample string 6",
  "create_date": "2024-06-15T17:07:19.8344842+00:00",
  "sales_territory_id": "66fe8bc9-5df8-4a32-886d-bf7291210a17",
  "sales_territory_code": "sample string 9",
  "sales_territory": {
    "id": "ad27d696-3bf2-4cee-a0ab-783671404410",
    "code": "sample string 2",
    "description": "sample string 3",
    "sales_organization_id": "dc6dcd46-303c-468e-86ad-1f30d08a8e5e",
    "sales_organization_code": "sample string 5",
    "sales_organization": {
      "id": "6bcb72a6-f3fe-4eee-b871-80beb58c7446",
      "code": "sample string 2",
      "name": "sample string 3",
      "description": "sample string 4",
      "db_country_id": "7322ea7b-9b2a-4802-a3d0-6d02881f7244",
      "db_currency_id": "54bab0b5-9e6f-4044-8bc6-469f2aea5999",
      "db_language_id": "2b8e3c22-6c3b-4ba2-b6f9-3791210fc305",
      "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": "2024-06-15T17:07:19.8344842+00:00"
    },
    "modified_dateutc": "2024-06-15T17:07:19.8344842+00:00"
  },
  "marketing_segment_id": "1b2808db-042f-45ac-adcc-c9ad53ef664b",
  "marketing_segment_code": "sample string 11",
  "sales_organization_id": "8cd68d47-931d-4ab7-8f5a-02a6f773df26",
  "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": "a737bab0-6d1b-4cf1-bca5-761221e20e77",
  "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": "9f7532db-3891-453b-be49-fa08784e0b0a",
  "db_country_code": "sample string 28",
  "feelist_id": "4fca0721-a5ab-463b-823a-71a77e3f602e",
  "feelist_reference_back_office": "sample string 30",
  "feelist": {
    "id": "8d6ad56c-b890-488e-a0c5-d225f8cf8f41",
    "name": "sample string 2",
    "description": "sample string 3",
    "is_default": true,
    "default_price": 1.0,
    "sales_organization_id": "67d7724e-a960-4198-bf7d-6edbaf902d3a",
    "sales_organization_code": "sample string 6",
    "reference_back_office": "sample string 7",
    "modified_dateutc": "2024-06-15T17:07:19.8344842+00:00",
    "db_currency_id": "f28c5396-f7ee-4b1a-9a4e-d996b31e39d8",
    "db_currency_code": "sample string 10"
  },
  "company_type_id": "3f29f978-2b0b-45a0-81a7-9635232d2cf1",
  "company_type_name": "sample string 32",
  "company_type": {
    "id": "7258b3ef-eb3c-4ea1-bd09-369e001e42d3",
    "name": "sample string 2",
    "description": "sample string 3",
    "sales_organization_id": "27233ddf-bb96-484d-a394-b3cf947eef9f",
    "sales_organization_code": "sample string 5"
  },
  "db_language_id": "59204449-e1d1-4919-99ce-fca6cc3628bb",
  "db_language_code": "sample string 34",
  "code": "sample string 35",
  "article_price_label_id": "02767eeb-4973-429d-8a87-f865724cb4df",
  "article_price_label_code": "sample string 37",
  "db_payment_method_id": "e43494bb-f04e-4312-af5c-7b34acb58ca1",
  "db_payment_method_reference_back_office": "sample string 39",
  "db_payment_methods": {
    "id": "c01d0339-5e32-47e1-af86-8a6d00b123b0",
    "name": "sample string 2",
    "description": "sample string 3",
    "reference_back_office": "sample string 4",
    "activated": true,
    "modified_dateutc": "2024-06-15T17:07:19.8344842+00:00"
  },
  "company_sector_id": "d0e36c23-451d-4bce-af73-b4e18bc8e6f2",
  "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": "1d157de3-1b95-4b30-a8a6-3f49934300ea",
  "service_manager_user_code": "sample string 52",
  "finance_manager_user_id": "effbfc18-101e-426c-8e44-edd376c25a8e",
  "finance_manager_user_code": "sample string 54",
  "account_manager_user_id": "cd36c4af-b98b-4446-b074-fb3f2ebc002c",
  "account_manager_user_code": "sample string 56",
  "company_status_id": "d9f7d3d6-adfc-4b3b-90ef-6ed3b72c466d",
  "invoice_email_to": "sample string 58",
  "modified_dateutc": "2024-06-15T17:07:19.8344842+00:00",
  "id2": 60
}