HTML to inline package

OpenAPI V2

Render HTML report to inline XBRL format.

post

Render HTML report to inline XBRL format maintaining the format (look and feel) of the HTML report). Content is provided in an archive (.zip). For each of the functionality where in our API is produced result file we produce hash of the file that identifies the contents of the file. User can validate the hash value in hash validation functionality and to know if any changes are applied. By default the file hash is disabled, but it can be controlled from the dropdown below. Response body will be for example:

{ 
    "inlineXbrl": "JVBERxLjQKMSAw...", 
    "hashResult": { 
        "Hash_Result": "nKDBo115PBhw3U3Y= " 
    } 
}

Authorizations

Query parameters

isHashedbooleanOptional

Specifies whether to have a hashcode included in the output. By default the value is false.

Default: false

packageNamestringOptional

Required if ishashed is set to true. Specifices the name of the name of the .zip package

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 · binaryOptional

Responses

200

OK

application/json

400

Bad Request

application/json

401

Unauthorized

post

HTTPcURLJavaScriptPython

POST /rendering/instance/html-to-inline-package HTTP/1.1
Host: 
Authorization: Bearer JWT
x-api-version: text
Content-Type: application/octet-stream
Accept: */*
Content-Length: 8

"binary"

{
  "inlineXbrl": "JVBERxLjQKMSAw..."
}