Consistent

OpenAPI V2

Render the XBRL report (.xbrl) into a readable consistent presentation report.

post

Render the XBRL report (.xbrl) into a readable consistent presentation report in accordance to the 'CP' specification rule set. 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

html or pdfstringOptional

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

application/jsontext/jsonapplication/*+json

reportContentBase64string · byte | nullableOptional

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

Example: PD94bWwgdmVyc2lvbj...

fileNamestring | nullableOptional

The name of the file.

Example: My report.xbrl

Responses

200

OK

application/json

400

Bad Request

application/json

401

Unauthorized

post

HTTPcURLJavaScriptPython

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

{
  "reportContentBase64": "SlZCRVJ4TGpRS01TQXcuLi4="
}

application/jsontext/jsonapplication/*+json

Without HashWith Hash

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