Single file
OpenAPI V2
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 · byteRequiredExample:
The file content represented as Base64 string
UEsDBBQ...
fileNamestring · min: 1RequiredExample:
The name of the file.
My report.xbr
fileExtensionstring · min: 1RequiredExample:
The extension of the file.
.xbr
Responses
200
OK
application/json
400
Bad Request
application/json
401
Unauthorized
post
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
}
]
}
}
}
Was this helpful?