XHTML

PreviousRender NextHTML to inline package

Was this helpful?

Render the XBRL report (.xbrl) into a readable report in inline.

post

Render the XBRL report (.xbrl) into a readable report formatted as inline XBRL. 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:

{ 
    "htmlContent": "JVBERxLjQKMSAw...", 
    "pdfContent": "GdsWdcdxDsaFgSd...", 
    "hashResult": { 
        "Hash_Result": "nKDBo115PBhw3U3Y= " 
    } 
}

Authorizations

Query parameters

outputstringoptional

Optional. Specifies output format. If missing result is in both html and pdf format.

isHashedbooleanoptional

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

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.

Body

reportContentBase64string · byte | nullableoptional

Value of the parameter 'ReportContentBase64' must be base64content of the instance file (.xbrl)

Example: PD94bWwgdmVyc2lvbj...

renderingSettingsobjectoptional

fileNamestring | nullableoptional

The name of the file.

Example: My report.xbrl

Responses

application/json

objectoptional

application/json

post

POST /rendering/instance/xhtml HTTP/1.1
Host: 
Authorization: Bearer JWT
x-api-version: text
Content-Type: application/json
Accept: */*
Content-Length: 50

{
  "reportContentBase64": "SlZCRVJ4TGpRS01TQXcuLi4="
}

{
  "htmlContent": "JVBERxLjQKMSAw...",
  "pdfContent": "SlZCRVJ4TGpRS01TQXcuLi4="
}