Single file

OpenAPI V2

Create hash code for (single) file.

post

Generate hash code for a (single) file.

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

idOrBase64Contentstring · byterequired

The file content represented as Base64 string

Example: UEsDBBQ...

fileNamestring · min: 1required

The name of the file.

Example: My report.xbr

fileExtensionstring · min: 1required

The extension of the file.

Example: .xbr

Responses

application/json

objectoptional

application/json

post

HTTPcURLJavaScriptPython

POST /input-import/hash-creation/single-file HTTP/1.1
Host: 
Authorization: Bearer JWT
x-api-version: text
Content-Type: application/json
Accept: */*
Content-Length: 84

{
  "idOrBase64Content": "UEsDBBQ...",
  "fileName": "My report.xbr",
  "fileExtension": ".xbr"
}

{
  "hashResult": {
    "reportingPackageHash": "nKDBo115PBhw3U3Y=",
    "isReportingPackageHashValid": "Invalid",
    "fileList": [
      {
        "fileName": "My report.xbrl",
        "fileHash": "11xrvYBwFw5htgf=",
        "isFileHashValid": "Invalid",
        "fileSize": "3.212890625",
        "isFolder": true
      }
    ],
    "folderStructure": {
      "name": "My folder",
      "subFolders": [
        {
          "name": "My folder",
          "subFolders": [
            "[Circular Reference]"
          ],
          "files": [
            {
              "fileName": "My report.xbrl",
              "fileHash": "11xrvYBwFw5htgf=",
              "isFileHashValid": "Invalid",
              "fileSize": "3.212890625",
              "isFolder": true
            }
          ]
        }
      ],
      "files": [
        {
          "fileName": "My report.xbrl",
          "fileHash": "11xrvYBwFw5htgf=",
          "isFileHashValid": "Invalid",
          "fileSize": "3.212890625",
          "isFolder": true
        }
      ]
    }
  }
}