Uniform

OpenAPI V2

Was this helpful?

Render the XBRL report (.xbrl) and apply uniformation in the process.

post

Render the XBRL report (.xbrl) and apply uniformation changes (best practices) to the XBRL report in the process and create a new version of the XBRL report (.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:

{ 
    "uniformedXbrlInstance": "JVBERxLjQKMSAw...", 
    "uniformLog": "GdsWdcdxDsaFgSd...", 
    "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

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

xbrlInstancestring · byte | nullableOptionalExample: PD94bWwgdmVyc2lvbj...

fileNamestring | nullableOptional

Responses

200

application/json

400

Bad Request

application/json

401

Unauthorized

post

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

{
  "xbrlInstance": "SlZCRVJ4TGpRS01TQXcuLi4=",
  "uniformOptions": {
    "language": "nl",
    "unusedContexts": true,
    "unusedUnits": true,
    "duplicatedContexts": true,
    "duplicatedUnits": true,
    "duplicatedFacts": true,
    "nonCanonicalNamespaces": true,
    "unusedNamespaces": true,
    "unclassifiedCharacters": true
  }
}

{
  "uniformedXbrlInstance": "SlZCRVJ4TGpRS01TQXcuLi4=",
  "uniformLog": ""
}