Retrieves the company file with the specified key.

Request Information

URI Parameters :

NameDescriptionTypeAdditional information
id

The company file id.

 globally unique identifier

Required

Body Parameters :

None.

Response Information

Resource Description :

IHttpActionResult containing the company file, or 404 Not Found if it doesn't exist.

company_files
NameDescriptionTypeAdditional information
id

Primary Key

 globally unique identifier
company_id

Foreign key of the company this file is attached to.

 globally unique identifier
file_name

Original file name, including extension.

 string
name

Display name of the file.

 string
description

Free-text description of the file.

 string
file_type

File type/category classification.

 string
mime_type

MIME type of the file (e.g. "application/pdf", "image/jpeg").

 string
image_width

Width of the file, in pixels, when it is an image.

 integer
image_heigth

Height of the file, in pixels, when it is an image.

 integer
file_size

Size of the file, in bytes.

 integer
date_update

Local date and time the file was last updated.

 date
date_add

Local date and time the file was added.

 date
dateutc_add

UTC date and time the file was added.

 date
user_id

Foreign key of the user who added this file.

 globally unique identifier
is_showonweb

Indicates whether this file should be shown on the customer-facing web/e-Service portal.

 boolean
file_content

Raw binary content of the file.

 Collection of byte
modified_dateutc

Readonly system field managed by database, filled with GetUtcDate when adding,updating

 date

Response Formats

application/json, text/json

Sample: 
{
  "id": "41f766d7-bf89-49c9-a235-4fa6f0243784",
  "company_id": "018f6815-bf8f-473e-aadc-4bf12b4da780",
  "file_name": "sample string 3",
  "name": "sample string 4",
  "description": "sample string 5",
  "file_type": "sample string 6",
  "mime_type": "sample string 7",
  "image_width": 8,
  "image_heigth": 9,
  "file_size": 10,
  "date_update": "2026-09-16T09:21:37.1252739+00:00",
  "date_add": "2026-09-16T09:21:37.1252739+00:00",
  "dateutc_add": "2026-09-16T09:21:37.1252739+00:00",
  "user_id": "666a2a01-db5e-4ece-8225-ca7d631bd2cf",
  "is_showonweb": true,
  "file_content": "QEA=",
  "modified_dateutc": "2026-09-16T09:21:37.1252739+00:00"
}

application/xml, text/xml

Sample: 
<company_files xmlns:i="http://www.w3.org/2001/XMLSchema-instance">
  <company_id>018f6815-bf8f-473e-aadc-4bf12b4da780</company_id>
  <date_add xmlns:d2p1="http://schemas.datacontract.org/2004/07/System">
    <d2p1:DateTime>2026-09-16T09:21:37.1252739Z</d2p1:DateTime>
    <d2p1:OffsetMinutes>0</d2p1:OffsetMinutes>
  </date_add>
  <date_update xmlns:d2p1="http://schemas.datacontract.org/2004/07/System">
    <d2p1:DateTime>2026-09-16T09:21:37.1252739Z</d2p1:DateTime>
    <d2p1:OffsetMinutes>0</d2p1:OffsetMinutes>
  </date_update>
  <dateutc_add xmlns:d2p1="http://schemas.datacontract.org/2004/07/System">
    <d2p1:DateTime>2026-09-16T09:21:37.1252739Z</d2p1:DateTime>
    <d2p1:OffsetMinutes>0</d2p1:OffsetMinutes>
  </dateutc_add>
  <description>sample string 5</description>
  <file_content>QEA=</file_content>
  <file_name>sample string 3</file_name>
  <file_size>10</file_size>
  <file_type>sample string 6</file_type>
  <id>41f766d7-bf89-49c9-a235-4fa6f0243784</id>
  <image_heigth>9</image_heigth>
  <image_width>8</image_width>
  <is_showonweb>true</is_showonweb>
  <mime_type>sample string 7</mime_type>
  <modified_dateutc>2026-09-16T09:21:37.125Z</modified_dateutc>
  <name>sample string 4</name>
  <user_id>666a2a01-db5e-4ece-8225-ca7d631bd2cf</user_id>
</company_files>