File

OpenAPI V2

PreviousCertificate NextDownload

Was this helpful?

Retrieve file list.

get

Retrieve the list of files as ID's within your domain.

Authorizations

Path parameters

fileIdsstringRequired

Query parameters

fileIdsstring[]Optional

IDs of the files to be returned.

Example: ["38caa766-9dcd-4681-a955-cb3d9028b18f","963be853-fdcd-4681-a955-cb3d9028b18f"]

Header parameters

x-api-versionstringRequired

ApplicationNameanyOptional

Name of the application to integrates with API’s to Semansys.Next.

PartnerNameanyOptional

Contract owner (organization) name that have embedded the API’s.

PartnerIDanyOptional

Business Identification Number (BIN) of the contract owner (organization) to embeds the API’s.

CustomerNameanyOptional

Customer (organization) name (ie. accounting firm, intermediary, ....).

CustomerIDanyOptional

Business Identification Number (BIN) of the customer.

ClientNameanyOptional

Client (organization) name of the customer of the accounting firm, intermediary...

ClientIDanyOptional

Business Identification Number (BIN) of the client.

Responses

200

application/json

400

Bad Request

application/json

401

Unauthorized

get

GET /customer-corner/file/{fileIds} HTTP/1.1
Host: 
Authorization: Bearer JWT
x-api-version: text
Accept: */*

[
  {
    "id": "063be713-f...",
    "userEmail": "user@gmail.com",
    "name": "My Test File",
    "size": 1253,
    "type": ".xbrl",
    "sha256": "5B63E7C115FA...",
    "createdOn": "2019-05-17",
    "isDomain": true,
    "isPublic": true,
    "history": [
      {
        "id": "dbe33c92-8...",
        "fileId": "063be713-f...",
        "action": "Downloaded",
        "atTime": "2019-05-20",
        "properties": [
          {
            "id": "063be713...",
            "type": "91063921-5...",
            "key": "NumberOfFacts",
            "value": "2"
          }
        ]
      }
    ],
    "properties": [
      {
        "id": "063be713...",
        "type": "91063921-5...",
        "key": "NumberOfFacts",
        "value": "2"
      }
    ]
  }
]

List user files.

get

Gives the list of files owned by the user defined by the user email.

Authorizations

Query parameters

idstringOptional

The user email.

Example: user@gmail.com

includeHistorybooleanOptional

Whether to include the history for each of the files.

Default: false

includePropertiesbooleanOptional

Whether to include the properties for each of the files.

Default: false

Header parameters

x-api-versionstringRequired

ApplicationNameanyOptional

Name of the application to integrates with API’s to Semansys.Next.

PartnerNameanyOptional

Contract owner (organization) name that have embedded the API’s.

PartnerIDanyOptional

Business Identification Number (BIN) of the contract owner (organization) to embeds the API’s.

CustomerNameanyOptional

Customer (organization) name (ie. accounting firm, intermediary, ....).

CustomerIDanyOptional

Business Identification Number (BIN) of the customer.

ClientNameanyOptional

Client (organization) name of the customer of the accounting firm, intermediary...

ClientIDanyOptional

Business Identification Number (BIN) of the client.

Responses

200

application/json

400

Bad Request

application/json

401

Unauthorized

get

GET /customer-corner/file HTTP/1.1
Host: 
Authorization: Bearer JWT
x-api-version: text
Accept: */*

[
  {
    "id": "063be713-f...",
    "userEmail": "user@gmail.com",
    "name": "My Test File",
    "size": 1253,
    "type": ".xbrl",
    "sha256": "5B63E7C115FA...",
    "createdOn": "2019-05-17",
    "isDomain": true,
    "isPublic": true,
    "history": [
      {
        "id": "dbe33c92-8...",
        "fileId": "063be713-f...",
        "action": "Downloaded",
        "atTime": "2019-05-20",
        "properties": [
          {
            "id": "063be713...",
            "type": "91063921-5...",
            "key": "NumberOfFacts",
            "value": "2"
          }
        ]
      }
    ],
    "properties": [
      {
        "id": "063be713...",
        "type": "91063921-5...",
        "key": "NumberOfFacts",
        "value": "2"
      }
    ]
  }
]

Upload a file

post

Upload a file to the platform.

Authorizations

Header parameters

x-api-versionstringRequired

ApplicationNameanyOptional

Name of the application to integrates with API’s to Semansys.Next.

PartnerNameanyOptional

Contract owner (organization) name that have embedded the API’s.

PartnerIDanyOptional

Business Identification Number (BIN) of the contract owner (organization) to embeds the API’s.

CustomerNameanyOptional

Customer (organization) name (ie. accounting firm, intermediary, ....).

CustomerIDanyOptional

Business Identification Number (BIN) of the customer.

ClientNameanyOptional

Client (organization) name of the customer of the accounting firm, intermediary...

ClientIDanyOptional

Business Identification Number (BIN) of the client.

Body

contentstring · byte | nullableOptionalExample: PD94bWwgdmVyc2lvbj0...

userIdstring | nullableOptionalExample: user@gmail.com

fileNamestring | nullableOptionalExample: My file.xbrl

Responses

200

The ID of the file ("38caa766-9dcd-4681-a955-cb3d9028b18f")

application/json

Responsestring

400

The reason why file could not be uploaded, represented as string.

application/json

401

Unauthorized

404

File not found.

415

Unsupported file type.

post

POST /customer-corner/file HTTP/1.1
Host: 
Authorization: Bearer JWT
x-api-version: text
Content-Type: application/json
Accept: */*
Content-Length: 88

{
  "content": "PD94bWwgdmVyc2lvbj0...",
  "userId": "user@gmail.com",
  "fileName": "My file.xbrl"
}

http://www.nltaxonomie.nl/nt18/kvk/20231213/entrypoints/kvk-rpt-jaarverantwoording-2023-nlgaap-micro.xsd

Delete file.

delete

Delete one or more file from the platform by ID.

Authorizations

Header parameters

x-api-versionstringRequired

ApplicationNameanyOptional

Name of the application to integrates with API’s to Semansys.Next.

PartnerNameanyOptional

Contract owner (organization) name that have embedded the API’s.

PartnerIDanyOptional

Business Identification Number (BIN) of the contract owner (organization) to embeds the API’s.

CustomerNameanyOptional

Customer (organization) name (ie. accounting firm, intermediary, ....).

CustomerIDanyOptional

Business Identification Number (BIN) of the customer.

ClientNameanyOptional

Client (organization) name of the customer of the accounting firm, intermediary...

ClientIDanyOptional

Business Identification Number (BIN) of the client.

Body

string[]Optional

Responses

200

The files were successfully deleted.

Responsestring

400

Delete files failed.

401

Unauthorized

delete

DELETE /customer-corner/file HTTP/1.1
Host: 
Authorization: Bearer JWT
x-api-version: text
Content-Type: application/json
Accept: */*
Content-Length: 33

[
  "063be713-f...",
  "963be853-f..."
]

http://www.nltaxonomie.nl/nt18/kvk/20231213/entrypoints/kvk-rpt-jaarverantwoording-2023-nlgaap-micro.xsd