Request Information
URI Parameters :
None.
Body Parameters :
None.
Response Information
Resource Description :
company| Name | Description | Type | Additional information |
|---|---|---|---|
| id |
Primary Key |
globally unique identifier |
Required |
| archived |
Archive this company to not have it anymore on the search |
boolean | |
| name | string |
Max length: 64 |
|
| notes |
Notes/Remark field |
string | |
| create_date |
Creation date+time |
date | |
| sales_territory_id | globally unique identifier | ||
| marketing_segment_id |
Marketing Segment of the company (Sales (Visit frequency logic) +Services (Planning Jobs To Be Planned) ) |
globally unique identifier | |
| sales_organization_id | globally unique identifier | ||
| sys_opening_hours | string | ||
| opening_hours | string | ||
| vat_reg_code |
VAT number |
string |
Max length: 50 |
| credit_limit | decimal number | ||
| article_price_label_id | globally unique identifier | ||
| article_order_channel_rule_id | globally unique identifier | ||
| 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 | |
| phone |
Phone number of the company |
string |
Max length: 50 |
| mobile | string | ||
| 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 |
| street2 |
Bus |
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_state_id | globally unique identifier | ||
| db_country_id |
Address:Country |
globally unique identifier | |
| latitude_decimal | decimal number | ||
| longitude_decimal | decimal number | ||
| company_sales_status_id | globally unique identifier | ||
| company_discount_family_id | globally unique identifier | ||
| discount | decimal number | ||
| company_type_id |
Company Type |
globally unique identifier | |
| db_language_id |
Language of the company.If empty, will use the default on the system |
globally unique identifier | |
| code |
Field used for Embedded entity (store there your ERP PK) |
string |
Max length: 50 |
| feelist_id | globally unique identifier | ||
| db_payment_method_id | globally unique identifier | ||
| company_picture | Collection of byte | ||
| is_client | boolean | ||
| account_manager_user_id | globally unique identifier | ||
| create_by_user_id | globally unique identifier | ||
| company_vat_id | globally unique identifier | ||
| finance_manager_user_id | globally unique identifier | ||
| service_manager_user_id | globally unique identifier | ||
| sys_sales_territory_id_changed | boolean | ||
| modified_dateutc |
Readonly system field managed by database, filled with GetUtcDate when adding,updating |
date | |
| udf1 | string |
Max length: 4000 |
|
| udf2 | string |
Max length: 4000 |
|
| udf3 | string |
Max length: 4000 |
|
| udf4 | string |
Max length: 4000 |
|
| udf5 | string |
Max length: 4000 |
|
| udf6 | string |
Max length: 4000 |
|
| udf7 | string |
Max length: 4000 |
|
| udf8 | string |
Max length: 4000 |
|
| udf9 | string |
Max length: 4000 |
|
| udf10 | string |
Max length: 4000 |
|
| udf11 | string |
Max length: 4000 |
|
| udf12 | string |
Max length: 4000 |
|
| udf13 | string |
Max length: 4000 |
|
| udf14 | string |
Max length: 4000 |
|
| udf15 | string |
Max length: 4000 |
|
| udf16 | string |
Max length: 4000 |
|
| udf17 | string |
Max length: 4000 |
|
| udf18 | string |
Max length: 4000 |
|
| udf19 | string |
Max length: 4000 |
|
| udf20 | string |
Max length: 4000 |
|
| udf21 | string |
Max length: 4000 |
|
| udf22 | string |
Max length: 4000 |
|
| udf23 | string |
Max length: 4000 |
|
| udf24 | string |
Max length: 4000 |
|
| udf25 | string |
Max length: 4000 |
|
| udf26 | string |
Max length: 4000 |
|
| udf27 | string |
Max length: 4000 |
|
| udf28 | string |
Max length: 4000 |
|
| udf29 | string |
Max length: 4000 |
|
| udf30 | string |
Max length: 4000 |
|
| udf31 | string |
Max length: 4000 |
|
| udf32 | string |
Max length: 4000 |
|
| udf33 | string |
Max length: 4000 |
|
| udf34 | string |
Max length: 4000 |
|
| udf35 | string |
Max length: 4000 |
|
| udf36 | string |
Max length: 4000 |
|
| udf37 | string |
Max length: 4000 |
|
| udf38 | string |
Max length: 4000 |
|
| udf39 | string |
Max length: 4000 |
|
| udf40 | string |
Max length: 4000 |
|
| udf41 | string |
Max length: 4000 |
|
| udf42 | string |
Max length: 4000 |
|
| udf43 | string |
Max length: 4000 |
|
| udf44 | string |
Max length: 4000 |
|
| udf45 | string |
Max length: 4000 |
|
| udf46 | string |
Max length: 4000 |
|
| udf47 | string |
Max length: 4000 |
|
| udf48 | string |
Max length: 4000 |
|
| udf49 | string |
Max length: 4000 |
|
| udf50 | string |
Max length: 4000 |
|
| udf51 | string |
Max length: 4000 |
|
| udf52 | string |
Max length: 4000 |
|
| udf53 | string |
Max length: 4000 |
|
| udf54 | string |
Max length: 4000 |
|
| udf55 | string |
Max length: 4000 |
|
| udf56 | string |
Max length: 4000 |
|
| udf57 | string |
Max length: 4000 |
|
| udf58 | string |
Max length: 4000 |
|
| udf59 | string |
Max length: 4000 |
|
| udf60 | string |
Max length: 4000 |
|
| udf61 | string |
Max length: 4000 |
|
| udf62 | string |
Max length: 4000 |
|
| udf63 | string |
Max length: 4000 |
|
| udf64 | string |
Max length: 4000 |
|
| udf65 | string |
Max length: 4000 |
|
| udf66 | string |
Max length: 4000 |
|
| udf67 | string |
Max length: 4000 |
|
| udf68 | string |
Max length: 4000 |
|
| udf69 | string |
Max length: 4000 |
|
| udf70 | string |
Max length: 4000 |
|
| udf71 | string |
Max length: 4000 |
|
| udf72 | string |
Max length: 4000 |
|
| udf73 | string |
Max length: 4000 |
|
| udf74 | string |
Max length: 4000 |
|
| udf75 | string |
Max length: 4000 |
|
| udf76 | string |
Max length: 4000 |
|
| udf77 | string |
Max length: 4000 |
|
| udf78 | string |
Max length: 4000 |
|
| udf79 | string |
Max length: 4000 |
|
| udf80 | string |
Max length: 4000 |
|
| udf81 | string |
Max length: 4000 |
|
| udf82 | string |
Max length: 4000 |
|
| udf83 | string |
Max length: 4000 |
|
| udf84 | string |
Max length: 4000 |
|
| udf85 | string |
Max length: 4000 |
|
| udf86 | string |
Max length: 4000 |
|
| udf87 | string |
Max length: 4000 |
|
| udf88 | string |
Max length: 4000 |
|
| udf89 | string |
Max length: 4000 |
|
| udf90 | string |
Max length: 4000 |
|
| udf91 | string |
Max length: 4000 |
|
| udf92 | string |
Max length: 4000 |
|
| udf93 | string |
Max length: 4000 |
|
| udf94 | string |
Max length: 4000 |
|
| udf95 | string |
Max length: 4000 |
|
| udf96 | string |
Max length: 4000 |
|
| udf97 | string |
Max length: 4000 |
|
| udf98 | string |
Max length: 4000 |
|
| udf99 | string |
Max length: 4000 |
|
| udf100 | string |
Max length: 4000 |
Response Formats
application/json, text/json
{
"id": "3f5bd43b-c4f3-4f85-bf54-7d0acb0b8f5b",
"archived": true,
"name": "sample string 3",
"notes": "sample string 4",
"create_date": "2026-01-11T21:04:52.4979272+00:00",
"sales_territory_id": "7e1c954e-6edb-473d-91d2-d8445ab0b841",
"marketing_segment_id": "007b5525-2a5a-48ca-ac6c-afcc800594ea",
"sales_organization_id": "fa7cceb0-6ad6-4455-a4ad-b85b80b9c406",
"sys_opening_hours": "sample string 9",
"opening_hours": "sample string 10",
"vat_reg_code": "sample string 11",
"credit_limit": 12.0,
"article_price_label_id": "834a388a-1830-4a32-9f4b-f722ddf9e6e2",
"article_order_channel_rule_id": "c6d6d9bc-942e-44a4-bd77-04c4fb81725d",
"is_working_address": true,
"parent_id": "d6f8fd71-d3b7-4c8a-889b-4fd7dc8e8e45",
"phone": "sample string 17",
"mobile": "sample string 18",
"fax": "sample string 19",
"url": "sample string 20",
"email": "sample string 21",
"street": "sample string 22",
"street2": "sample string 23",
"street_number": "sample string 24",
"city": "sample string 25",
"zip": "sample string 26",
"db_state_id": "dc16e1d7-0060-473d-9838-c704262fc2b9",
"db_country_id": "ca66b3ad-4a9b-4cd2-9664-2a9b0629b9a9",
"latitude_decimal": 29.0,
"longitude_decimal": 30.0,
"company_sales_status_id": "f9825044-22c8-4560-bc0c-18c8ae1b54da",
"company_discount_family_id": "a59c6ba7-9a92-4dcc-b441-b3dba1012ea7",
"discount": 33.0,
"company_type_id": "5eed1722-b1a7-465f-b073-5f2c5595d0d0",
"db_language_id": "3c699a95-4aab-4b9b-a177-f444488a8a61",
"code": "sample string 36",
"feelist_id": "168a34dc-466d-4a8c-aa96-7915b160d34f",
"db_payment_method_id": "53c1406a-211e-4f0f-9979-68059c1a4a78",
"company_picture": "QEA=",
"is_client": true,
"account_manager_user_id": "059cdfea-b483-47ef-af7a-e3f7a051c8e1",
"create_by_user_id": "1d427217-9c49-4f19-8bae-8a5a5a4f4779",
"company_vat_id": "21f9cab8-502a-4c7d-96af-72e13a8f9b9a",
"finance_manager_user_id": "b753637e-6b4c-403d-aa30-cbb8e565fa4e",
"service_manager_user_id": "b2b9bb25-3f14-44e5-8e9f-f4e63f8fbed0",
"sys_sales_territory_id_changed": true,
"modified_dateutc": "2026-01-11T21:04:52.4979272+00:00",
"udf1": "sample string 47",
"udf2": "sample string 48",
"udf3": "sample string 49",
"udf4": "sample string 50",
"udf5": "sample string 51",
"udf6": "sample string 52",
"udf7": "sample string 53",
"udf8": "sample string 54",
"udf9": "sample string 55",
"udf10": "sample string 56",
"udf11": "sample string 57",
"udf12": "sample string 58",
"udf13": "sample string 59",
"udf14": "sample string 60",
"udf15": "sample string 61",
"udf16": "sample string 62",
"udf17": "sample string 63",
"udf18": "sample string 64",
"udf19": "sample string 65",
"udf20": "sample string 66",
"udf21": "sample string 67",
"udf22": "sample string 68",
"udf23": "sample string 69",
"udf24": "sample string 70",
"udf25": "sample string 71",
"udf26": "sample string 72",
"udf27": "sample string 73",
"udf28": "sample string 74",
"udf29": "sample string 75",
"udf30": "sample string 76",
"udf31": "sample string 77",
"udf32": "sample string 78",
"udf33": "sample string 79",
"udf34": "sample string 80",
"udf35": "sample string 81",
"udf36": "sample string 82",
"udf37": "sample string 83",
"udf38": "sample string 84",
"udf39": "sample string 85",
"udf40": "sample string 86",
"udf41": "sample string 87",
"udf42": "sample string 88",
"udf43": "sample string 89",
"udf44": "sample string 90",
"udf45": "sample string 91",
"udf46": "sample string 92",
"udf47": "sample string 93",
"udf48": "sample string 94",
"udf49": "sample string 95",
"udf50": "sample string 96",
"udf51": "sample string 97",
"udf52": "sample string 98",
"udf53": "sample string 99",
"udf54": "sample string 100",
"udf55": "sample string 101",
"udf56": "sample string 102",
"udf57": "sample string 103",
"udf58": "sample string 104",
"udf59": "sample string 105",
"udf60": "sample string 106",
"udf61": "sample string 107",
"udf62": "sample string 108",
"udf63": "sample string 109",
"udf64": "sample string 110",
"udf65": "sample string 111",
"udf66": "sample string 112",
"udf67": "sample string 113",
"udf68": "sample string 114",
"udf69": "sample string 115",
"udf70": "sample string 116",
"udf71": "sample string 117",
"udf72": "sample string 118",
"udf73": "sample string 119",
"udf74": "sample string 120",
"udf75": "sample string 121",
"udf76": "sample string 122",
"udf77": "sample string 123",
"udf78": "sample string 124",
"udf79": "sample string 125",
"udf80": "sample string 126",
"udf81": "sample string 127",
"udf82": "sample string 128",
"udf83": "sample string 129",
"udf84": "sample string 130",
"udf85": "sample string 131",
"udf86": "sample string 132",
"udf87": "sample string 133",
"udf88": "sample string 134",
"udf89": "sample string 135",
"udf90": "sample string 136",
"udf91": "sample string 137",
"udf92": "sample string 138",
"udf93": "sample string 139",
"udf94": "sample string 140",
"udf95": "sample string 141",
"udf96": "sample string 142",
"udf97": "sample string 143",
"udf98": "sample string 144",
"udf99": "sample string 145",
"udf100": "sample string 146"
}
application/xml, text/xml
<company xmlns:i="http://www.w3.org/2001/XMLSchema-instance"> <account_manager_user_id>059cdfea-b483-47ef-af7a-e3f7a051c8e1</account_manager_user_id> <archived>true</archived> <article_order_channel_rule_id>c6d6d9bc-942e-44a4-bd77-04c4fb81725d</article_order_channel_rule_id> <article_price_label_id>834a388a-1830-4a32-9f4b-f722ddf9e6e2</article_price_label_id> <city>sample string 25</city> <code>sample string 36</code> <company_discount_family_id>a59c6ba7-9a92-4dcc-b441-b3dba1012ea7</company_discount_family_id> <company_picture>QEA=</company_picture> <company_sales_status_id>f9825044-22c8-4560-bc0c-18c8ae1b54da</company_sales_status_id> <company_type_id>5eed1722-b1a7-465f-b073-5f2c5595d0d0</company_type_id> <company_vat_id>21f9cab8-502a-4c7d-96af-72e13a8f9b9a</company_vat_id> <create_by_user_id>1d427217-9c49-4f19-8bae-8a5a5a4f4779</create_by_user_id> <create_date>2026-01-11T21:04:52.497Z</create_date> <credit_limit>12</credit_limit> <db_country_id>ca66b3ad-4a9b-4cd2-9664-2a9b0629b9a9</db_country_id> <db_language_id>3c699a95-4aab-4b9b-a177-f444488a8a61</db_language_id> <db_payment_method_id>53c1406a-211e-4f0f-9979-68059c1a4a78</db_payment_method_id> <db_state_id>dc16e1d7-0060-473d-9838-c704262fc2b9</db_state_id> <discount>33</discount> <email>sample string 21</email> <fax>sample string 19</fax> <feelist_id>168a34dc-466d-4a8c-aa96-7915b160d34f</feelist_id> <finance_manager_user_id>b753637e-6b4c-403d-aa30-cbb8e565fa4e</finance_manager_user_id> <id>3f5bd43b-c4f3-4f85-bf54-7d0acb0b8f5b</id> <is_client>true</is_client> <is_working_address>true</is_working_address> <latitude_decimal>29</latitude_decimal> <longitude_decimal>30</longitude_decimal> <marketing_segment_id>007b5525-2a5a-48ca-ac6c-afcc800594ea</marketing_segment_id> <mobile>sample string 18</mobile> <modified_dateutc>2026-01-11T21:04:52.497Z</modified_dateutc> <name>sample string 3</name> <notes>sample string 4</notes> <opening_hours>sample string 10</opening_hours> <parent_id>d6f8fd71-d3b7-4c8a-889b-4fd7dc8e8e45</parent_id> <phone>sample string 17</phone> <sales_organization_id>fa7cceb0-6ad6-4455-a4ad-b85b80b9c406</sales_organization_id> <sales_territory_id>7e1c954e-6edb-473d-91d2-d8445ab0b841</sales_territory_id> <service_manager_user_id>b2b9bb25-3f14-44e5-8e9f-f4e63f8fbed0</service_manager_user_id> <street>sample string 22</street> <street2>sample string 23</street2> <street_number>sample string 24</street_number> <sys_opening_hours>sample string 9</sys_opening_hours> <sys_sales_territory_id_changed>true</sys_sales_territory_id_changed> <udf1>sample string 47</udf1> <udf10>sample string 56</udf10> <udf100>sample string 146</udf100> <udf11>sample string 57</udf11> <udf12>sample string 58</udf12> <udf13>sample string 59</udf13> <udf14>sample string 60</udf14> <udf15>sample string 61</udf15> <udf16>sample string 62</udf16> <udf17>sample string 63</udf17> <udf18>sample string 64</udf18> <udf19>sample string 65</udf19> <udf2>sample string 48</udf2> <udf20>sample string 66</udf20> <udf21>sample string 67</udf21> <udf22>sample string 68</udf22> <udf23>sample string 69</udf23> <udf24>sample string 70</udf24> <udf25>sample string 71</udf25> <udf26>sample string 72</udf26> <udf27>sample string 73</udf27> <udf28>sample string 74</udf28> <udf29>sample string 75</udf29> <udf3>sample string 49</udf3> <udf30>sample string 76</udf30> <udf31>sample string 77</udf31> <udf32>sample string 78</udf32> <udf33>sample string 79</udf33> <udf34>sample string 80</udf34> <udf35>sample string 81</udf35> <udf36>sample string 82</udf36> <udf37>sample string 83</udf37> <udf38>sample string 84</udf38> <udf39>sample string 85</udf39> <udf4>sample string 50</udf4> <udf40>sample string 86</udf40> <udf41>sample string 87</udf41> <udf42>sample string 88</udf42> <udf43>sample string 89</udf43> <udf44>sample string 90</udf44> <udf45>sample string 91</udf45> <udf46>sample string 92</udf46> <udf47>sample string 93</udf47> <udf48>sample string 94</udf48> <udf49>sample string 95</udf49> <udf5>sample string 51</udf5> <udf50>sample string 96</udf50> <udf51>sample string 97</udf51> <udf52>sample string 98</udf52> <udf53>sample string 99</udf53> <udf54>sample string 100</udf54> <udf55>sample string 101</udf55> <udf56>sample string 102</udf56> <udf57>sample string 103</udf57> <udf58>sample string 104</udf58> <udf59>sample string 105</udf59> <udf6>sample string 52</udf6> <udf60>sample string 106</udf60> <udf61>sample string 107</udf61> <udf62>sample string 108</udf62> <udf63>sample string 109</udf63> <udf64>sample string 110</udf64> <udf65>sample string 111</udf65> <udf66>sample string 112</udf66> <udf67>sample string 113</udf67> <udf68>sample string 114</udf68> <udf69>sample string 115</udf69> <udf7>sample string 53</udf7> <udf70>sample string 116</udf70> <udf71>sample string 117</udf71> <udf72>sample string 118</udf72> <udf73>sample string 119</udf73> <udf74>sample string 120</udf74> <udf75>sample string 121</udf75> <udf76>sample string 122</udf76> <udf77>sample string 123</udf77> <udf78>sample string 124</udf78> <udf79>sample string 125</udf79> <udf8>sample string 54</udf8> <udf80>sample string 126</udf80> <udf81>sample string 127</udf81> <udf82>sample string 128</udf82> <udf83>sample string 129</udf83> <udf84>sample string 130</udf84> <udf85>sample string 131</udf85> <udf86>sample string 132</udf86> <udf87>sample string 133</udf87> <udf88>sample string 134</udf88> <udf89>sample string 135</udf89> <udf9>sample string 55</udf9> <udf90>sample string 136</udf90> <udf91>sample string 137</udf91> <udf92>sample string 138</udf92> <udf93>sample string 139</udf93> <udf94>sample string 140</udf94> <udf95>sample string 141</udf95> <udf96>sample string 142</udf96> <udf97>sample string 143</udf97> <udf98>sample string 144</udf98> <udf99>sample string 145</udf99> <url>sample string 20</url> <vat_reg_code>sample string 11</vat_reg_code> <zip>sample string 26</zip> </company>